diff --git a/.circleci/config.yml b/.circleci/config.yml index 23d11a3..5904a84 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -32,8 +32,9 @@ jobs: - run: command: make test workflows: - version: 2 build-and-test: jobs: - - build - test + - build: + requires: + - test diff --git a/README.md b/README.md index cf085d7..9fe3fe0 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,12 @@ After configuring the providers you would like to utilize, simply run `./sliproad`. This will spin up the webserver at `127.0.0.1:3000`, listening on all addresses. +## API + +This project is largely API-first, and documentation can be found here: + +https://github.com/gmemstr/sliproad/wiki/API + ## Building This project leverages a Makefile to macro common commands for running, testing diff --git a/assets/config_examples/README.md b/assets/config_examples/README.md deleted file mode 100644 index e69de29..0000000