squid-js/README.md

48 lines
1.6 KiB
Markdown
Raw Normal View History

2018-09-03 10:34:14 +02:00
[![banner](https://raw.githubusercontent.com/oceanprotocol/art/master/github/repo-banner%402x.png)](https://oceanprotocol.com)
# keeper-js
> 🐋 JavaScript implementation of ocean protocol keeper
> [oceanprotocol.com](https://oceanprotocol.com)
2018-09-03 10:44:37 +02:00
[![Travis (.com)](https://img.shields.io/travis/com/oceanprotocol/ocean-client-js.svg)](https://travis-ci.com/oceanprotocol/ocean-client-js)
[![GitHub contributors](https://img.shields.io/github/contributors/oceanprotocol/ocean-client-js.svg)](https://github.com/oceanprotocol/ocean-client-js/graphs/contributors)
2018-09-03 10:34:14 +02:00
---
2018-09-03 10:56:38 +02:00
**🐲🦑 THERE BE DRAGONS AND SQUIDS. This is in alpha state and you can expect running into problems. If you run into them, please open up [a new issue](https://github.com/oceanprotocol/ocean-client-js/issues). 🦑🐲**
2018-09-03 10:34:14 +02:00
---
## Table of Contents
2018-09-03 10:56:38 +02:00
- [Get Started](#get-started)
- [License](#license)
2018-09-03 10:34:14 +02:00
---
2018-09-03 10:51:02 +02:00
## Get Started
To start develppment you need to:
```batch
npm i
npm run start:dev
```
This will start a watcher for changes of the code.
2018-09-03 10:34:14 +02:00
## License
```
Copyright 2018 Ocean Protocol Foundation Ltd.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.