brest-docker

Automatic documentation creation for the Brest library

npm install brest-docker
9 downloads in the last week
11 downloads in the last month

Brest Docker

About

Brest Docker is the automated documentation extension for the Brest library.

How do I use it?

1. Install from package manager

If your project uses package.json, simply include

"dependencies": {
    ...
    "brest-docker": "*",
    ...
}

and then in the shell, in project root folder execute:

$ npm install

Otherwise, you can install brest globally with npm and have it available from anywhere on your machine:

$ npm install -g brest-docker

Note that you require Brest to be installed prior to use docker.

Known issues

JSON schema is quite unstable for now: it doesn't support internal links by #id's, some properties may be missing, etc…

Changes

0.0.1-3

  • Updated resource template to work with filter descriptions as objects

0.0.1-2

  • Fixed crash when API resource is referencing missing schema
  • Removed junk files from package

0.0.1-1

Dependencies fix

0.0.1

Here goes the Docker…

MIT License

Copyright © 2013 Maxim Tovstashev max.kitsch@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you