Skip to content
This repository was archived by the owner on Feb 6, 2019. It is now read-only.

Commit 5693642

Browse files
committed
Add README and LICENCE
0 parents  commit 5693642

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017 Leapfrog Technology Inc.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Chill REST API
2+
3+
REST API for the [chill](https://github.com/leapfrogtechnology/chill) monitoring service.
4+
5+
## Setup
6+
7+
Install dependencies
8+
```bash
9+
# Using npm
10+
$ npm install
11+
12+
# Or using yarn
13+
$ yarn
14+
```
15+
16+
Then start the app
17+
```
18+
$ npm start
19+
```
20+
21+
## Contributing
22+
23+
Read our [contributing guide](https://github.com/leapfrogtechnology/chill/blob/master/CONTRIBUTING.md) to learn about our development process, how to propose bugs and improvements.
24+
25+
## License
26+
27+
Chill is licensed under the [MIT License](LICENSE.md).

0 commit comments

Comments
 (0)