vacp2p/nim-libp2p
1
0
Fork 0
mirror of https://github.com/vacp2p/nim-libp2p.git synced 2026-01-09 15:57:56 -05:00
Code Issues Packages Projects Releases 14 Wiki Activity

Update the links to tutorials (#151)

Browse Source 
* update readme and organize the example folder

* adding package list

* add packages done

* basic readme done

* fix the go-daemon example folder

* add go-daemon folder in readme

* fix readme icon

* add badges

* add nim min version

* Update README background

Co-Authored-By: Dmitriy Ryajov <dryajov@gmail.com>

* fix all the comments

* Update README.md wording

Co-Authored-By: Dmitriy Ryajov <dryajov@gmail.com>

* fix file path in examples/

* add comments to example

* add comments to directchat and fix start.nim

* remove unnecessary modules from directchat

* del customdata

* improve directchat

* finish second.nim

* removea gcsafe

* with err

* change var to let

* remove final.nim

* fix comments on pull request

* fix comments on pull request

* replace result with return

* add hint when start and exit command

* update output string

* fix above comments

* add api documentation

* fix readme format

* update readme format

* readme table of content done

* fix format

* fix format

* include links to the tutorial article

Co-authored-by: Dmitriy Ryajov <dryajov@gmail.com>
This commit is contained in:
李婷婷
2020-04-30 14:57:49 +08:00
committed by GitHub
parent e1928456a7
commit a4090c7382
16 changed files with 283 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -61,16 +61,21 @@ nimble install libp2p
## Usage
### API
The specification is available on [API.md](docs/API.md) (coming soon).
The specification is available in the [docs/api](docs/api) folder.
### Getting Started
Please read the [GETTING_STARTED.md](docs/GETTING_STARTED.md) guide.
### Tutorials and Examples
Examples can be found in the [examples folder](/examples).
Example code can be found in the [examples folder](/examples).
#### Direct Chat Tutorial
- [Part I](https://our.status.im/nim-libp2p-tutorial-a-peer-to-peer-chat-example-1/): Set up the main function and use multi-thread for processing IO.
- [Part II](https://our.status.im/nim-libp2p-tutorial-a-peer-to-peer-chat-example-2/): Dial remote peer and allow customized user input commands.
- [Part III](https://our.status.im/nim-libp2p-tutorial-a-peer-to-peer-chat-example-3/): Configure and establish a libp2p node.
### Using the Go Daemon
Please find the installation and usage intructions in [GO_DAEMON.md](docs/GO_DAEMON.md).
Please find the installation and usage intructions in [daemonapi.md](docs/api/libp2p/daemonapi.md).
Examples can be found in the [examples/go-daemon folder](https://github.com/status-im/nim-libp2p/tree/readme/examples/go-daemon);