Skip to content
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.

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

Make the readme more user friendly #237

Closed
jacobheun opened this issue Aug 14, 2018 · 1 comment
Closed

Make the readme more user friendly #237

jacobheun opened this issue Aug 14, 2018 · 1 comment
Labels
status/ready Ready to be worked

Comments

@jacobheun
Copy link
Contributor

Will the many recent updates to libp2p and our Q3 objective to get more people using libp2p directly, it's time to do a full review/audit of the readme. There are issues like #231 that cause confusion and other api inconsistencies that are being addressed; such as #235 and #236. We need to do a full audit of the readme to make sure it's as easy as possible for new users to get started and existing users to upgrade to the latest version.

As libp2p requires many other components to be configured to work optimally, it's important that we showcase those pieces and make it clear how/where they can be used.

@mpetrunic
Copy link
Member

Closing as stale, readme has been updated multiple times since this issue has been opened.

maschad pushed a commit to maschad/js-libp2p that referenced this issue Jun 21, 2023
maschad pushed a commit to maschad/js-libp2p that referenced this issue Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status/ready Ready to be worked
Projects
None yet
Development

No branches or pull requests

2 participants