added examples to the readme

1 files changed, 37 insertions, 0 deletions

diff --git a/README.md b/README.md
index a22cb4a..32295d0 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # myal - My Anime Library
 
+## Overview
+
 My Anime Library is a cli-tool written in C to manage an anime and manga list.  
 I used to track which anime I have watched and what episode I'm on by writing in
 a text file, which got annoying after a while.  
@@ -10,6 +12,8 @@ Is it a complete overkill to write this in C? Yes
 But why not? I wanted some practice with C, so if you see any glaring errors or
 unsafe code feel free to point it out and roast me.  
 
+## Quickstart
+
 You need a database with tables `anime` and `manga`. Attached in this repo
 is a setup script for the database. Simply execute
 ```
@@ -32,3 +36,36 @@ to gcc in the second line. Or you could simply do
 ```
 gcc -o myal main.c -lsqlite3
 ```
+
+## Usage
+
+Currently there are 4 modes:
+- get, which retrieves an anime or manga by the given name argument
+- set, which updates the episode or chapter of a given entry
+- status, which updates the status of a given entry
+- add, which adds a new entry to a given table
+
+Here are examples for each mode:
+
+```
+myal get anime jojo
+```
+Assuming the database contains "JoJo's Bizarre Adventure" and "JoJo's Bizarre
+Adventure - Stardust Crusaders", both will be retrieved.  
+
+```
+myal set manga "Nikubami Honegishimi" 3
+```
+This will set the chapter of the entry "Nikubami Honegishimi" to 3. The qoutes
+are needed because of the whitespace in the name.  
+
+```
+myal status anime Jigokuraku done
+```
+This will set the status of the entry "Jigokuraku" to "done".  
+
+```
+myal add anime "Detective Conan" 1 "not started"
+```
+This will add the entry "Detective Conan" with the episode 1 set to the status
+"not started" to the anime table.