diff --git a/CHANGELOG.md b/CHANGELOG.md index 12e70211f..07944f3e9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,8 @@ ### Added +- Advertise `libvroom` in README and wiki (#42) + ### Changed - Use `std::chrono::milliseconds` for `Timeout` value (#728) diff --git a/README.md b/README.md index 2155c6a51..58a8dd644 100644 --- a/README.md +++ b/README.md @@ -81,10 +81,15 @@ 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 @@ -92,15 +97,11 @@ instructions](https://github.com/VROOM-Project/vroom/wiki/Building). 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