Skip to content

Commit

Permalink
docs: add initial docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shadowgate15 committed Aug 23, 2021
1 parent 7824039 commit b32bfa6
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,45 @@

## Install

[npm][]:

```sh
npm install @breejs/api
```

[yarn][]:

```sh
yarn add @breejs/api
```

## Usage

Extend bree with the plugin:

```js
Bree.extend(require('@breejs/api').plugin);

const bree = new Bree(config);
```

The API will start automatically when the Bree constructor is called.

## Options

| Option | Type | Description |
|:------:|:------:|----------------------------------|
| port | Number | The port the API will listen on. |

## API

Check out the [API Docs](https://documenter.getpostman.com/view/17142435/TzzDLbNG).

## Contributors


## License

[MIT](LICENSE) © [Nick Baugh](http://niftylettuce.com/)

##
1 change: 1 addition & 0 deletions config/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ const config = {
appName: env.APP_NAME,
appColor: env.APP_COLOR,
twitter: env.TWITTER,
port: 4000,

// build directory
buildBase: 'build',
Expand Down

0 comments on commit b32bfa6

Please sign in to comment.