From b5ff7390b5bb0807adfc4e7860b2d5a2cdea172d Mon Sep 17 00:00:00 2001 From: Dan Jones <dan.jones@noc.ac.uk> Date: Wed, 18 Jan 2023 12:13:09 +0000 Subject: [PATCH] docs: include local setup and test in readme --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index deafdb7..cebf20b 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 -- GitLab