libp2p / libp2p/go-libp2p-daemon

Usage Documentation

Open
#247 1 comment 0 reactions 1 assignee View on GitHub

@vyzo is already working on this.

Since Mar 15, 2021.

difficulty:easy enhancement
Dominant language
Go
Stars
95
Forks
41
PR merge metrics
No merged PRs in 30d

Description

There's a "spec" in [specs/CONFIG.md](https://github.com/libp2p/go-libp2p-daemon/blob/master/specs/CONFIG.md) but it doesn't actually say _how_ to use a config.

There's also a useless "go read the go docs" comment in the README.

We need to replace the Usage section in the README with a short section on how to get started:

1. How to setup a config with a persistent ID.
2. How to start p2pd.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.