Skip to content

Commit

Permalink
better docs&readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Okm165 committed Jun 1, 2024
1 parent 7823481 commit e5aaf1f
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 5 deletions.
Binary file added .github/sharp-p2p-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ members = [
exclude = []

[workspace.package]
version = "0.1.0"
version = "0.1.3"
edition = "2021"
repository = "https://github.com/iosis-tech/sharp-p2p"
license-file = "LICENSE"
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# SHARP-P2P

<div align="center">
<img src=".github/sharp-p2p-logo.png" alt="SHARP-P2P Logo" width="200">
<br><br>
<img src="https://img.shields.io/badge/v0.1.3-green?style=flat-square&logo=git&logoColor=white&label=version" alt="Version">
<a href="https://docs.sharp-p2p.iosis.tech/introduction.html">
<img src="https://img.shields.io/badge/v0.1.3-blue?style=flat-square&logo=mdbook&logoColor=white&label=docs" alt="Docs">
</a>
<img src="https://img.shields.io/github/actions/workflow/status/iosis-tech/sharp-p2p/test.yaml?style=flat-square&logo=githubactions&logoColor=white&label=Continuous%20Integration" alt="Continuous Integration">
</div>

## Overview

The Sharp p2p is a shared peer-to-peer network of Zero-Knowledge Provers. This network allows any party to join and utilize its services, operating with two main user roles:

1. **Delegators**: Users who present jobs to be executed on the network.
Expand Down
12 changes: 8 additions & 4 deletions docs/book.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
[book]
authors = ["Okm165"]
language = "en"
multilingual = false
src = "src"
title = "SHARP-P2P documentation"
description = "Documentation for SHARP-P2P, a shared peer-to-peer network of Zero-Knowledge Provers."
authors = ["Okm165 - Bartosz Nowak"]
language = "en"

[output.html]
smart-punctuation = true
mathjax-support = true
git-repository-url = "https://github.com/iosis-tech/sharp-p2p"

0 comments on commit e5aaf1f

Please sign in to comment.