AndrewTrieu/note-rpc
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Andrew Trieu
2023-03-11 18:11:15 +02:00
committed by GitHub
parent 96ba7ab14f
commit 66afacb98e
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -10,15 +10,15 @@ To use the application, you need to run the `server.py` script first. This start
2. Get notes
3. Quit
## Adding a Note
### Adding a Note
To add a note, choose option 1 and enter the topic, note name, note text, and optionally a link to a Wikipedia page related to the topic. If the topic already exists, the note will be added to it. Otherwise, a new topic will be created and the note added to it. If a Wikipedia link is added, it will be stored along with the note in the database.
## Getting Notes
### Getting Notes
To get notes, choose option 2 and enter the topic. The application will retrieve all the notes for the topic and display them on the console. If a Wikipedia link was added to a note, it will be displayed along with the note.
## Quitting
### Quitting
To quit the application, choose option 3.