1 | # worker-server.js
|
2 |
|
3 | # Worker server to run jobs instructed by central server
|
4 |
|
5 | ## Current status
|
6 |
|
7 | [![NPM version](https://img.shields.io/npm/v/worker-server.svg)](https://www.npmjs.com/package/worker-server)
|
8 | [![Build Status](https://img.shields.io/travis/overlookmotel/worker-server/master.svg)](http://travis-ci.org/overlookmotel/worker-server)
|
9 | [![Dependency Status](https://img.shields.io/david/overlookmotel/worker-server.svg)](https://david-dm.org/overlookmotel/worker-server)
|
10 | [![Dev dependency Status](https://img.shields.io/david/dev/overlookmotel/worker-server.svg)](https://david-dm.org/overlookmotel/worker-server)
|
11 | [![Coverage Status](https://img.shields.io/coveralls/overlookmotel/worker-server/master.svg)](https://coveralls.io/r/overlookmotel/worker-server)
|
12 |
|
13 | ## Usage
|
14 |
|
15 | NOT READY FOR USE YET
|
16 |
|
17 | ## Tests
|
18 |
|
19 | Use `npm test` to run the tests. Use `npm run cover` to check coverage.
|
20 |
|
21 | ## Changelog
|
22 |
|
23 | See [changelog.md](https://github.com/overlookmotel/worker-server/blob/master/changelog.md)
|
24 |
|
25 | ## Issues
|
26 |
|
27 | If you discover a bug, please raise an issue on Github. https://github.com/overlookmotel/worker-server/issues
|
28 |
|
29 | ## Contribution
|
30 |
|
31 | Pull requests are very welcome. Please:
|
32 |
|
33 | * ensure all tests pass before submitting PR
|
34 | * add an entry to changelog
|
35 | * add tests for new features
|
36 | * document new functionality/API additions in README
|