Skip to content

Update readme #337

@lewisjkl

Description

@lewisjkl

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:

  1. What the service does at a high level
  2. How to run the application
    A. What dependencies are needed? On what host/port?
  3. 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions