Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
szekelymilan committed Mar 24, 2020
1 parent 5c568cd commit 61d53a8
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Too lazy for typing? Run the CLI in **interactive mode**! 😎
- 💾 Saves login credentials
- 🖥 Shows subject averages
- 🏠 Downloads assignments
- ✉ Downloads messages
- ✅ Tested
- ⛏ Maintained

Expand All @@ -50,19 +51,22 @@ $ yarn global add e-kreta-cli
```
$ kreta --help
Check your electronic diary - from right inside your terminal.
Check your electronic diary - from right inside your terminal.
Usage
$ kreta <assignments|averages|reconfigure> [options]
Usage
$ kreta <assignments|averages|messages|reconfigure> [options]
Use 'kreta' for interactive mode.
Use 'kreta' for interactive mode.
Options
assignments:
-o, --output Output folder (defaults to assignments)
Options
assignments:
-o, --output Output folder (defaults to assignments)
Examples
See: https://github.com/szekelymilan/e-kreta-cli#examples
messages:
-o, --output Output folder (defaults to messages)
Examples
See: https://github.com/szekelymilan/e-kreta-cli#examples
```

## Examples
Expand All @@ -85,6 +89,12 @@ $ kreta averages
$ kreta assignments -o "My Assignments"
```

#### Download messages to My Messages folder

```
$ kreta messages -o "My Messages"
```

## Contributors

- Many thanks to [boapps](https://github.com/boapps) for making [e-kreta-api-docs](https://github.com/boapps/e-kreta-api-docs).
Expand Down

0 comments on commit 61d53a8

Please sign in to comment.