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

Improve documentation #1

Open
after-ephemera opened this issue Apr 14, 2017 · 8 comments
Open

Improve documentation #1

after-ephemera opened this issue Apr 14, 2017 · 8 comments

Comments

@after-ephemera
Copy link
Owner

I'd love to have some real documentation so the project can get found on npmjs.com. This would include instructions on how to use serialwriter, and common gotchas.

@nicknadeau
Copy link

Hello, I'm new to open source and would like to take this one on

@after-ephemera
Copy link
Owner Author

@nicknadeau I'd love that! Feel free to have a go at it and let me know if you have any questions!

@mdimovich
Copy link
Contributor

Is this issue still open? I'm also new to open source and know a bit of markdown, so I could clean up the document and make it look nice

@after-ephemera
Copy link
Owner Author

@mdimovich yes it is open and I welcome all contributions!

@mdimovich
Copy link
Contributor

Just sent a pull request! Let me know what you think :)

@after-ephemera
Copy link
Owner Author

Thanks to @mdimovich for updating the styling and clearing up some wording on the README. The next steps on this issue will be to

  1. Add a "Contributing" section
  2. Add an "Overview" section. This would offer some use cases, and why it would be useful to print serial output to a file.

@tuhinmallick
Copy link

Is this issue still available then I would like to give it a try.

@after-ephemera
Copy link
Owner Author

I haven't touched this repo in a while but I'd be happy to have you look it over and contribute where you can @tuhinmallick.

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

No branches or pull requests

4 participants