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

Create README #6

Open
sttic opened this issue Aug 10, 2020 · 0 comments
Open

Create README #6

sttic opened this issue Aug 10, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@sttic
Copy link
Contributor

sttic commented Aug 10, 2020

Create README.md and potentially more detailed Wiki documenting project. When taking on the issue, you should split this issue into separate README and Wiki ones and expand or clarify on the points.

Product (Wiki)

  • features
  • use cases
  • design decisions and reasoning
  • ...

Development

  • setting up repo
  • running locally
  • how Firebase is connected/used
  • testing
  • deployment strategies
  • ...
@sttic sttic added the documentation Improvements or additions to documentation label Aug 10, 2020
sttic added a commit that referenced this issue Aug 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant