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

Update readme #337

Open

lewisjkl opened this issue Mar 18, 2020 · 0 comments

Contributor

lewisjkl commented Mar 18, 2020

The Readme is pretty out of date in several spots. We should update this so that it is easier to follow and fully up to date.

In my opinion, the readme should have:

What the service does at a high level
How to run the application
A. What dependencies are needed? On what host/port?
How to run all tests

This would be a good start. From here we can look into adding things like diagrams to explain the application/how it works.

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