From a212a58d623f9537da41bf6c6920c29d2c5be8d0 Mon Sep 17 00:00:00 2001 From: Dan Jones <dan.jones@noc.ac.uk> Date: Wed, 18 Jan 2023 12:23:48 +0000 Subject: [PATCH] docs: move dependencies in readme The dependencies only apply to the "Installing in a project" instructions. --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cebf20b..5d0c553 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,6 @@ Implements: - validation of messages against a specified OpenAPI schema - decode/encode stubs -## Dependencies - -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. - ## Setup ``` @@ -35,9 +29,20 @@ yarn test ## Installing in your project +We may publish this to a public registry but for now you need to install the package +from git. + +### Requirements + +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. + +**TODO fix this in rollup config** + ### Yarn -#### Once public +#### Once public ```yarn yarn add git+https://git.noc.ac.uk/communications-backbone-system/backbone-adapter-javascript.git -- GitLab