updated readme onboarding instructions #60
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem Readme contained a few errors and lacked install instructions for docker Solution - added install instructions for docker and make - moved api usage instructions to app/api/readme - updated api usage instructions to fix /api/ error and add authentication token instructions Ticket URL https://mediform.atlassian.net/browse/MEDI-7 Documentation N/A Tests Run Tested readme instructions on mac os
|
Excellent! One thing I noticed is the inconsistent capitalization of the header text. I propose we use sentence case.
Other than that it looks great. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
Readmes contained a few minor errors and lacked install instructions for docker and others
Solution
Ticket URL
https://mediform.atlassian.net/browse/MEDI-7
Documentation
N/A
Tests Run
Tested readme instructions on mac os