-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md and package.json, add banner.png
- Loading branch information
1 parent
e179972
commit 5c1d2f4
Showing
3 changed files
with
76 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,75 @@ | ||
# e-kreta-cli | ||
# [![e-Kréta CLI](static/banner.png)](https://github.com/szekelymilan/e-kreta-cli) | ||
|
||
> 📚 Check your electronic diary - from right inside your terminal. | ||
[![PRs Welcome](https://badgen.net/badge/PRs/welcome/green)](https://github.com/szekelymilan/e-kreta-cli/pulls) | ||
[![Latest Release](https://badgen.net/github/release/szekelymilan/e-kreta-cli)](https://github.com/szekelymilan/e-kreta-cli/releases/latest) | ||
[![MIT License](https://badgen.net/badge/license/MIT/blue)](https://github.com/szekelymilan/e-kreta-cli/blob/master/LICENSE) | ||
|
||
## Table of Contents | ||
|
||
- [Description](#description) | ||
- [Features](#features) | ||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
- [Examples](#examples) | ||
- [License](#license) | ||
|
||
## Description | ||
|
||
Check your electronic diary in a second, by running a single command. | ||
|
||
Too lazy for typing the flags? Run the CLI in **interactive mode**! 😎 | ||
|
||
## Features | ||
|
||
- ⚡ Interactive mode via `--interactive` | ||
- 💾 Saves login credentials | ||
- 🖥 Shows subject averages | ||
- ✅ Tested | ||
- ⛏ Maintained | ||
|
||
## Installation | ||
|
||
#### npm | ||
|
||
``` | ||
$ npm i -g e-kreta-cli | ||
``` | ||
|
||
## Usage | ||
|
||
``` | ||
$ kreta --help | ||
Check your electronic diary - from right inside your terminal. | ||
Usage | ||
$ kreta <options> | ||
Options | ||
-a, --averages Show subject averages | ||
-i, --interactive Interactive mode | ||
--reconfigure Update configuration | ||
Examples | ||
See: https://github.com/szekelymilan/e-kreta-cli#examples | ||
``` | ||
|
||
## Examples | ||
|
||
#### Reconfigure | ||
|
||
``` | ||
$ kreta --reconfigure | ||
``` | ||
|
||
#### Show averages | ||
|
||
``` | ||
$ kreta -a | ||
``` | ||
|
||
## License | ||
|
||
MIT © [Milan Szekely](https://github.com/szekelymilan) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.