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

README.md #6

Open

astroash opened this issue May 3, 2018 · 0 comments

astroash commented May 3, 2018

Uhh ooo, you're project has no readme. It is really useful for other developers to have documentation for:

what the app does
what's in the config (variable names not the variables themselves)
how to install
how to run locally

Here's some examples of excellent readmes:
https://github.com/matiassingers/awesome-readme

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