diff --git a/README.md b/README.md index deafdb7567ad1ffca75eaa3e96362f01531af793..cebf20b5d33c68064690c4a87d8f5574162004eb 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,24 @@ An axios library. Axios is included as a dev dependency to run the tests. I've not installed it as a runtime dependency because in nuxt you need to use @nuxtjs/axios instead. -## Install +## Setup + +``` +yarn install +``` + +## Test + +The tests are written in [cucumber](https://cucumber.io/docs/installation/javascript/) + +This means we can have a common suite of [gherkin](https://github.com/cucumber/gherkin) +tests across adapter ports written in multiple languages. + +``` +yarn test +``` + +## Installing in your project ### Yarn