Skip to content

GitLab

Unverified Commit a212a58d authored by Dan Jones's avatar Dan Jones
Browse files

docs: move dependencies in readme 

The dependencies only apply to the "Installing in a project"
instructions.
parent b5ff7390
Hide whitespace changes
Inline Side-by-side
Showing with 12 additions and 7 deletions
README.md
View file @ a212a58d
...@@ -10,12 +10,6 @@ Implements: ...@@ -10,12 +10,6 @@ Implements:
- validation of messages against a specified OpenAPI schema - validation of messages against a specified OpenAPI schema
- decode/encode stubs - 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 ## Setup
``` ```
...@@ -35,9 +29,20 @@ yarn test ...@@ -35,9 +29,20 @@ yarn test
## Installing in your project ## 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 ### Yarn
#### Once public #### Once public
```yarn ```yarn
yarn add git+https://git.noc.ac.uk/communications-backbone-system/backbone-adapter-javascript.git yarn add git+https://git.noc.ac.uk/communications-backbone-system/backbone-adapter-javascript.git
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment