diff --git a/README.md b/README.md index cbb693b..076c0be 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,9 @@ To run this application: 4. Make a new PostgreSQL database by writing `createdb mydiary` 5. Create a .env file by typing `touch .env` to store your secret keys 6. In the .env file type - > `SECRET_JWT_KEY=|ENTER-YOUR-KEY-HERE|`
> `IBM_WATSON_API_KEY=|ENTER-YOUR-APIKEY-HERE|`
> `IBM_WATSON_API_URL=|ENTER-YOUR-PERSONAL-IBM-URL-HERE|`
+ > `SECRET_JWT_KEY=|ENTER-YOUR-KEY-HERE|`
+ > `IBM_WATSON_API_KEY=|ENTER-YOUR-APIKEY-HERE|`
+ > `IBM_WATSON_API_URL=|ENTER-YOUR-PERSONAL-IBM-URL-HERE|`
7. Type `npm run start-dev` in your terminal and you can use the API! ## API @@ -55,8 +57,8 @@ How to signup and login. - GET `/api/analyze/search/sentences/` allows a user to search their diary entries for any particular word. Will only provide the exact sentences that match with the searched word.   -Requires a word to be searched and assigned to the searchQuery key in the body.
  -Example: {searchQuery: "taco"}
- > -GET `/api/analyze/averagetone` allows a user to find their average tone from all their diary entries. - >   -Will showcase the average tone for all 8 tones.
+ -GET `/api/analyze/averagetone` allows a user to find their average tone from all their diary entries. +   -Will showcase the average tone for all 8 tones.
- GET `/api/analyze/findToneMatch` allows a user to find all sentences within their entries that emit a certain tone   -Tone's that a user can pick from are: "anger", "disgust", "fear", "joy", "sadness", "analytical", "confident", or "tentative"
  -Requires a selected tone and assigned to the tone key in the body.