Skip to content

Commit

Permalink
Update README.md and package.json, add banner.png
Browse files Browse the repository at this point in the history
  • Loading branch information
szekelymilan committed Feb 7, 2019
1 parent e179972 commit 5c1d2f4
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 2 deletions.
76 changes: 75 additions & 1 deletion README.md
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)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "e-kreta-cli",
"version": "0.0.1",
"description": "e-Kréta CLI",
"description": "Check your electronic diary - from right inside your terminal.",
"main": "cli.js",
"scripts": {},
"bin": {
Expand Down
Binary file added static/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5c1d2f4

Please sign in to comment.