Updating README to have more background, example usage, and more detailed installation instructions #119
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
I've added some project background to make the goals and capabilities of this project more clear to people not familiar with the codebase. Additionally, I've added an "Example Usage" section to the README so that it is, again, more clear to new users how they can use this software.
Finally, I've added a bit of description to each of the three installation options. I've put in some information on how they differ and when each case should be used.
Test plan
This is purely a documentation change so no real testing is required.