Skip to content

Commit

Permalink
refactor(readMe): adjusted docs to fix alignment
Browse files Browse the repository at this point in the history
  • Loading branch information
Ali-Aftab committed Feb 17, 2021
1 parent 50255e8 commit 10dd59b
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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|` <br/> > `IBM_WATSON_API_KEY=|ENTER-YOUR-APIKEY-HERE|` <br/> > `IBM_WATSON_API_URL=|ENTER-YOUR-PERSONAL-IBM-URL-HERE|` <br/>
> `SECRET_JWT_KEY=|ENTER-YOUR-KEY-HERE|` <br/>
> `IBM_WATSON_API_KEY=|ENTER-YOUR-APIKEY-HERE|` <br/>
> `IBM_WATSON_API_URL=|ENTER-YOUR-PERSONAL-IBM-URL-HERE|` <br/>
7. Type `npm run start-dev` in your terminal and you can use the API!

## API
Expand Down Expand Up @@ -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.
&nbsp;&nbsp;-Requires a word to be searched and assigned to the searchQuery key in the body. <br/>
&nbsp;&nbsp;-Example: {searchQuery: "taco"} <br/>
> -GET `/api/analyze/averagetone` allows a user to find their average tone from all their diary entries.
> &nbsp;&nbsp;-Will showcase the average tone for all 8 tones. <br/>
-GET `/api/analyze/averagetone` allows a user to find their average tone from all their diary entries.
&nbsp;&nbsp;-Will showcase the average tone for all 8 tones. <br/>
- GET `/api/analyze/findToneMatch` allows a user to find all sentences within their entries that emit a certain tone
&nbsp;&nbsp;-Tone's that a user can pick from are: "anger", "disgust", "fear", "joy", "sadness", "analytical", "confident", or "tentative" <br/>
&nbsp;&nbsp;-Requires a selected tone and assigned to the tone key in the body. <br/>
Expand Down

0 comments on commit 10dd59b

Please sign in to comment.