Skip to content

Commit 153aa4d

Browse files
author
Alexander Zutikov
committed
Change README.md and add description
1 parent e4ad694 commit 153aa4d

File tree

2 files changed

+23
-3
lines changed

2 files changed

+23
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
11
# NbgExrp
22

3-
**TODO: Add description**
3+
## Descripion
4+
```elixir
5+
-h, --help
6+
Desc: Show help message
7+
Usage: nbg_exrp -h, nbg_exrp --help
8+
-r, --rate
9+
Desc: Show current rate for USD
10+
Usage: nbg_exrp -r usd, nbg_exrp --rate usd
11+
12+
--all
13+
Desc: Shoo all currencies rates
14+
Usage: nbg_exp --all
15+
16+
-c, --convert
17+
Desc: Convert amount in currenty to GEL
18+
Usage: nbg_exrp -c 10 usd, nbg_exrp --conver 10 usd
19+
```
20+
421

522
## Installation
623

@@ -10,12 +27,11 @@ by adding `nbg_exrp` to your list of dependencies in `mix.exs`:
1027
```elixir
1128
def deps do
1229
[
13-
{:nbg_exrp, "~> 0.1.0"}
30+
{:nbg_exrp, "~> 0.1.0"}
1431
]
1532
end
1633
```
1734

1835
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
1936
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
2037
be found at [https://hexdocs.pm/nbg_exrp](https://hexdocs.pm/nbg_exrp).
21-

lib/nbg_exrp/cli.ex

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ defmodule NbgExrp.CLI do
4242
Desc: Show current rate for USD
4343
Usage: nbg_exrp -r usd, nbg_exrp --rate usd
4444
45+
--all
46+
Desc: Shoo all currencies rates
47+
Usage: nbg_exp --all
48+
4549
-c, --convert
4650
Desc: Convert amount in currenty to GEL
4751
Usage: nbg_exrp -c 10 usd, nbg_exrp --conver 10 usd

0 commit comments

Comments
 (0)