Skip to content

Commit dfa3211

Browse files
committed
readme: prepare for crate submission
1 parent 1249246 commit dfa3211

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

Cargo.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
11
[package]
22
name = "num2words"
33
version = "0.1.0"
4+
authors = ["Asperatus <rust@ballasi.com>"]
45
edition = "2018"
6+
description = "Convert numbers like 42 to forty-two"
7+
license = "MIT OR Apache-2.0"
8+
documentation = "https://docs.rs/num2words"
9+
repository = "https://github.com/Ballasi/num2words/"
10+
keywords = ["numbers", "words"]
11+
readme = "README.md"
512

613
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
714

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# num2words
22

3+
<a href="https://crates.io/crates/num2words"><img src="https://img.shields.io/crates/v/num2words"/></a> <a href="https://crates.io/crates/num2words"><img src="https://img.shields.io/crates/d/num2words"/></a> <a href="https://docs.rs/num2words"><img src="https://img.shields.io/docsrs/num2words"/></a> <a href="#license"><img src="https://img.shields.io/crates/l/num2words"/></a>
4+
35
Convert number like `42` to `forty-two`
46

57
Example usage:
@@ -8,7 +10,26 @@ use num2words::num2words;
810
assert_eq!(num2words!(42), Ok(String::from("forty-two")));
911
```
1012

11-
This lib will also be a downloadable binary in the near future.
13+
The app can also be run via a command-line interface.
14+
15+
Example:
16+
```sh
17+
$ num2words 42
18+
forty-two
19+
$ num2words 10 --to EUR
20+
ten euros
21+
```
22+
23+
You can download the app via the following command:
24+
```sh
25+
$ cargo install num2words
26+
```
27+
28+
For more information about the usage of `num2words` please refers to the
29+
docs or via the following command:
30+
```sh
31+
$ num2words --help
32+
```
1233

1334
This library is widely inspired by [Savoir-faire Linux's Python
1435
lib](https://github.com/savoirfairelinux/num2words/).

0 commit comments

Comments
 (0)