| 1 | # Paperboy
|
| 2 |
|
| 3 | Content Delivery Layer
|
| 4 |
|
| 5 | ## Installation
|
| 6 |
|
| 7 | ```bash
|
| 8 | $ npm add @neoskop/paperboy
|
| 9 | ```
|
| 10 |
|
| 11 | ## Usage Example
|
| 12 |
|
| 13 | ```javascript
|
| 14 | import { Paperboy } from '@neoskop/paperboy';
|
| 15 |
|
| 16 | new Paperboy({
|
| 17 | command: 'yarn build'
|
| 18 | });
|
| 19 | ```
|
| 20 |
|
| 21 | ##Development
|
| 22 |
|
| 23 | Build and start the project for development:
|
| 24 |
|
| 25 | ### Requirement
|
| 26 |
|
| 27 | - Node >= 8.9.1
|
| 28 |
|
| 29 | ### Install
|
| 30 |
|
| 31 | ```bash
|
| 32 | $ npm i
|
| 33 | ```
|
| 34 |
|
| 35 | ### Start
|
| 36 |
|
| 37 | Builds and starts the project with nodemon and watcher.
|
| 38 |
|
| 39 | ```bash
|
| 40 | $ npm start
|
| 41 | ```
|
| 42 |
|
| 43 | ### Build
|
| 44 |
|
| 45 | Builds the project (dist directory).
|
| 46 |
|
| 47 | ```bash
|
| 48 | $ npm run build
|
| 49 | ```
|
| 50 |
|
| 51 | ### Release
|
| 52 |
|
| 53 | Make sure to build and commit before releasing.
|
| 54 |
|
| 55 | ```bash
|
| 56 | $ npm version patch|minory|major
|
| 57 | $ npm publish
|
| 58 | ```
|