Skip to content

Commit

Permalink
Merge branch 'documentation/C++-API'
Browse files Browse the repository at this point in the history
  • Loading branch information
jcoupey committed Jul 11, 2022
2 parents 596b69f + b7cf880 commit 18c4290
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 11 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

### Added

- Advertise `libvroom` in README and wiki (#42)

### Changed

- Use `std::chrono::milliseconds` for `Timeout` value (#728)
Expand Down
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,26 +81,27 @@ it easy to send sample optimization requests for testing purposes.

Several options are available to get `vroom` running on command-line.

1. Use
[`vroom-docker`](https://github.com/VROOM-Project/vroom-docker).
2. Build from source following [the wiki
1. Build from source following [the wiki
instructions](https://github.com/VROOM-Project/vroom/wiki/Building).
2. Use
[`vroom-docker`](https://github.com/VROOM-Project/vroom-docker).

### Command-line usage

Refer to [this wiki
page](https://github.com/VROOM-Project/vroom/wiki/Usage)

#### Http wrapper

[`vroom-express`](https://github.com/VROOM-Project/vroom-express) is a
simple wrapper to use `vroom` with http requests. It's already bundled
in the `vroom-docker` setup.

#### Use from C++

The project can be used as a library as shown in [this
example](https://github.com/VROOM-Project/vroom/blob/master/libvroom_examples/libvroom.cpp).

### Usage
#### Using libvroom from C++

Refer to [this wiki
page](https://github.com/VROOM-Project/vroom/wiki/Usage)
The project can also used as a library from any C++ project, refer to
[this wiki
page](https://github.com/VROOM-Project/vroom/wiki/Using-libvroom).

## Tests

Expand Down

0 comments on commit 18c4290

Please sign in to comment.