New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Usage Documentation #247

Open

Stebalien opened this issue Mar 15, 2021 · 1 comment

Assignees

Labels

difficulty:easy enhancement

Member

Stebalien commented Mar 15, 2021 •

edited

Loading

There's a "spec" in 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:

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

Stebalien added enhancement difficulty:easy labels

Member Author

Stebalien commented Mar 15, 2021

Really, we need to document "getting up and running".

Stebalien mentioned this issue

Running with configuration file #243

Closed

Stebalien changed the title ~~Document Config~~ Usage Documentation

Stebalien assigned vyzo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment