Skip to content

Commit

Permalink
feat: Add docs to pipeline, and README
Browse files Browse the repository at this point in the history
  • Loading branch information
caleb-leinz committed Aug 23, 2024
1 parent d025645 commit f04c871
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,7 @@ jobs:
- uses: actions/checkout@v4
- name: Build
run: cargo build --verbose
- name: Build Docs
run: cargo doc --verbose
- name: Run tests
run: cargo test --verbose
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,16 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
}
```

## Documentation

The freedom API has a significant amount of documentation to get users up and
running quickly. To build the docs, simply run the following from the root of
this repository, once cloned.

```console
$ cargo doc --no-deps --open
```

## Chaining API Returns

Many of the data types exposed in this library can be navigated to through other
Expand Down

0 comments on commit f04c871

Please sign in to comment.