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

Add a decent README.md #1

Open
AlexStansfield opened this issue Sep 19, 2016 · 1 comment
Open

Add a decent README.md #1

AlexStansfield opened this issue Sep 19, 2016 · 1 comment

Comments

@AlexStansfield
Copy link
Member

Currently the README doesn't have anything useful other than config structure.

Expand the README.md to include:

  • Overview of what it does
  • How to install and setup
  • Explaination of Config
  • How to extend functionality with own Entity/Repo/Factory
@tacman
Copy link

tacman commented Jul 31, 2017

+1

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

No branches or pull requests

2 participants