Ghost/ghost/bootstrap-socket/README.md
Hannah Wolfe 014469f49b Added new bootstrap-socket package with a test
- History merged from Ghost, setup package structure and added a test
- This is exactly the kind of code that we should keep separate to Ghost, as it's rarely touched
- It's much easier to reason about and test when it's on its own
2020-08-07 16:59:25 +01:00

39 lines
570 B
Markdown

# Bootstrap Socket
## Install
`npm install @tryghost/bootstrap-socket --save`
or
`yarn add @tryghost/bootstrap-socket`
## Usage
## Develop
This is a mono repository, managed with [lerna](https://lernajs.io/).
Follow the instructions for the top-level repo.
1. `git clone` this repo & `cd` into it as usual
2. Run `yarn` to install top-level dependencies.
## Run
- `yarn dev`
## Test
- `yarn lint` run just eslint
- `yarn test` run lint and tests
# Copyright & License
Copyright (c) 2020 Ghost Foundation - Released under the [MIT license](LICENSE).