Ghost/ghost/members-theme-bindings/README.md

45 lines
753 B
Markdown
Raw Normal View History

# Members Theme Bindings
## Install
`npm install @tryghost/members-theme-bindings --save`
or
`yarn add @tryghost/members-theme-bindings`
## Usage
```js
const MembersThemeBindings = require('@tryghost/members-theme-bindings');
MembersThemeBindings.init({siteUrl: "https://ghost-site.com/root-ghost-path"});
```
## 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) 2019 Ghost Foundation - Released under the [MIT license](LICENSE).