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

More documentation #216

Closed
bittelc opened this issue Apr 17, 2019 · 1 comment
Closed

More documentation #216

bittelc opened this issue Apr 17, 2019 · 1 comment
Labels
docs Improvements on documentation

Comments

@bittelc
Copy link

bittelc commented Apr 17, 2019

Hello,

Since the initial blog plost that brought a lot of attention to Noise, there's been little updates on what's happening with the project, what the priorities are for roadmap (tags v1.0.0, v1.1.0, and v2.0.0 are equally ambiguous), and how to actually the use Noise as a networking stack in external apps.

We've attempted to use Noise in our own apps but we've run into lots of problems with implementation, particularly because there is very little documentation available. The examples directory seems to be a state of flux, as it no longer represents very accurately what was initially published on the blog post.

I would love to see better documentation and goals of upcoming development.

@rkeene rkeene self-assigned this Oct 24, 2019
@rkeene rkeene added this to the v2.0.0 milestone Oct 24, 2019
@rkeene rkeene removed their assignment Oct 24, 2019
@rkeene rkeene added the docs Improvements on documentation label Oct 24, 2019
@iwasaki-kenta
Copy link
Contributor

More complete godocs alongside examples are being provided in the next update #266. Also, Noise from then on will make use of semantic versioning. I echo a lot of the concerns regarding the present versioning system of Noise, and hope the update ceases these problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements on documentation
Projects
None yet
Development

No branches or pull requests

3 participants