-
Notifications
You must be signed in to change notification settings - Fork 1
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
Make readme more readable for users #12
Labels
Comments
If we did go the route of using screenshots as the product/endpoint demo, perhaps we could have those images auto-generated on each push/release, so that they're up-to-date with the code? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
If the README is going to be a product demo, then it needs to read more like user-facing documentation than a REST API spec. Maybe switch from text to screenshots?
Related and part of this task, maybe the dev docs should be moved to a separate document!
The text was updated successfully, but these errors were encountered: