Skip to content

Commit 23a011e

Browse files
committed
Add brief instructions to readme
1 parent fc1be97 commit 23a011e

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
11
# podcast-api-rust
22
Rust library for the Listen Notes Podcast API
3+
4+
## Check
5+
- formatting: `cargo fmt --check`
6+
- valid code: `cargo check`
7+
- linting: `cargo clippy`
8+
9+
## Build
10+
`cargo build`
11+
12+
## Test
13+
`cargo test`
14+
15+
## Usage
16+
Add this to your `Cargo.toml`:
17+
```toml
18+
[dependencies]
19+
podcast-api = "0.1"
20+
```

0 commit comments

Comments
 (0)