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

Update the README to be consistent with the other tools #3

Open
drewry opened this issue Jan 25, 2018 · 2 comments
Open

Update the README to be consistent with the other tools #3

drewry opened this issue Jan 25, 2018 · 2 comments

Comments

@drewry
Copy link
Member

drewry commented Jan 25, 2018

There are many tools in the opendnd tool suite. It would be great to have all of the README's to be more consistent.

@naltun
Copy link
Contributor

naltun commented Jun 20, 2018

What should the README be like? Should each be more-or-less the same? Maybe we can have something like:

h1 <Name of Tool>
h3 Brief description

h3 Header of some kind
p Describe <Name of Tool> here

h3 Header of some kind
p Talk about the OpenDnD project in general, detailing each project in an unordered list

h3 License
p License

I mean, this is just a rough idea to convey what I mean. Thoughts?

@drewry
Copy link
Member Author

drewry commented Jun 20, 2018

@naltun I think that makes sense, I think the main points we'd want to touch on are:

  1. What does this tool do?
  2. How do I install it?
  3. How can I use it as a CLI?
  4. How can I use it as a Node dependency?
  5. How do I contribute to this project?
  6. What's the license?

Other nice to haves would be badges showing the build status, NPM information, etc.

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

2 participants