Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
digizeph committed May 8, 2023
1 parent 58cc456 commit f0ea395
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,13 @@ less than 5 minutes). Currently, we are indexing BGP table dump and updates file

This Rust library provides access to the BGPKIT Broker API with the capability to search and paginate results.

For more details, please check out the BGPKIT API docs at <https://api.bgpkit.com/docs>.

## Usage

Add the following dependency line to your project's `Cargo.toml` file:
```yaml
bgpkit-broker = "0.5"
bgpkit-broker = "0.6"
```

## Example
Expand Down Expand Up @@ -75,8 +77,4 @@ performance and customization. If you are interested in deploying one, please co

## Built with ❤️ by BGPKIT Team

BGPKIT is a small-team start-up that focus on building the best tooling for BGP data in Rust. We have 10 years of
experience working with BGP data and believe that our work can enable more companies to start keeping tracks of BGP data
on their own turf. Learn more about what services we provide at https://bgpkit.com.

<a href="https://bgpkit.com"><img src="https://bgpkit.com/Original%20Logo%20Cropped.png" alt="https://bgpkit.com/favicon.ico" width="200"/></a>
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ page.
We also provide way to fetch the latest file information for each collector available with the
[BgpkitBroker::latest] call. The function returns JSON-deserialized result (see [CollectorLatestItem])
to the RESTful API at <https://api.broker.bgpkit.com/v2/latest>.
to the RESTful API at <https://api.bgpkit.com/broker/latest>.
```rust
use bgpkit_broker::BgpkitBroker;
Expand Down

0 comments on commit f0ea395

Please sign in to comment.