Skip to content

Commit 7f058d9

Browse files
committed
newsapi API overhaul and update readme
1 parent d9444e3 commit 7f058d9

File tree

8 files changed

+801
-460
lines changed

8 files changed

+801
-460
lines changed

Cargo.lock

Lines changed: 619 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,6 @@ authors = ["creativcoder"]
1212
[dependencies]
1313
crossterm = "0.20.0"
1414
dotenv = "0.15.0"
15-
newsapi = {path = "./newsapi"}
15+
newsapi = { path = "./newsapi", features = ["async"] }
1616
termimad = "0.14.2"
17+
tokio = {version = "1.11.0", features = ["full"] }

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,25 @@ A simple cli news reader app in Rust.
99

1010
2. [Refactoring the CLI app in Rust](https://www.youtube.com/watch?v=LHPV3z9OSic)
1111

12+
3. [Library API design overhaul, async and more](https://youtu.be/J_yGWdgeGQM)
13+
1214
## How to install
1315

1416
#### Ubuntu
1517

16-
Use cargo-deb subcommand (`cargo install cargo-deb`) to generate a package and then install system wide using dpkg
18+
Install the cargo-deb subcommand:
19+
`cargo install cargo-deb`
20+
21+
generate a deb package by running:
22+
23+
`cargo deb` in clinews repository
24+
25+
install the .deb package from target/debian using `dpkg -i <clinews.deb>`
1726

18-
#### Linux distribution
19-
Either cargo install --path .
2027

21-
or if you
28+
#### Other linux distribution
29+
30+
`cargo install --path .` - You will need rust toolchain setup for this.
2231

2332
## Running clinews
2433

@@ -30,4 +39,10 @@ Set the API key in your `.bashrc` or `.zshrc` like:
3039
export API_KEY=xxx
3140
```
3241

42+
then
43+
3344
Run `clinews` from terminal.
45+
46+
## Contributions
47+
48+
Feel free to file issues and PRs

0 commit comments

Comments
 (0)