From 507217881688eb0c23aa9b2dc7844591c784e527 Mon Sep 17 00:00:00 2001
From: arsenyjin <kinspotting@protonmail.com>
Date: Tue, 19 May 2020 13:21:24 +0200
Subject: [PATCH] add readme

---
 README.md | 103 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 102 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 29c5153a..ab0c7926 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,102 @@
-# ocean-js
\ No newline at end of file
+[![banner](https://raw.githubusercontent.com/oceanprotocol/art/master/github/repo-banner%402x.png)](https://oceanprotocol.com)
+
+
+<h1 align="center">Ocean-js</h1>
+
+> 🦑 JavaScript client library for Ocean Protocol
+> [oceanprotocol.com](https://oceanprotocol.com)
+
+This is in alpha state and you can expect running into problems. If you run into them, please open up a [new issue](/issues).
+
+## Table of Contents
+
+  - [Get Started](#get-started)
+     - [Local development](#local-development)
+  - [Testing](#testing)
+     - [Code Linting](#code-linting)
+  - [Packages](#packages)
+  - [Documentation](#documentation)
+  - [Contributing](#contributing)
+  - [Prior Art](#prior-art)
+  - [License](#license)
+
+# Get Started
+
+TBD
+
+### Local development
+
+As a pre-requisite, you need:
+
+- Node.js
+- npm
+
+Note: For MacOS, make sure to have `node@10` installed.
+
+Clone the project and install all dependencies:
+
+```bash
+git clone git@github.com:oceanprotocol/ocean-js.git
+cd ocean-js/
+
+# install packages
+npm i
+
+```
+
+# Testing
+
+Run tests with 
+
+```bash
+# for unit tests
+TBD
+
+# for test coverage
+TBD
+```
+
+### Code Linting
+
+Linting is setup for `JavaScript` with [ESLint](https://eslint.org) 
+
+```bash
+# to check lint issues
+npm run lint
+```
+Code style is enforced through the CI test process, builds will fail if there're any linting errors.
+
+## Documentation
+
+* [Release process](doc/RELEASE_PROCESS.md)
+* [Core Documentation](doc/contracts/README.md)
+* [Packaging of libraries](doc/PACKAGING.md)
+
+## Contributing
+
+See the page titled "[Ways to Contribute](https://docs.oceanprotocol.com/concepts/contributing/)" in the Ocean Protocol documentation.
+
+
+
+## Prior Art
+
+This project builds on top of the work done in open source projects:
+- [OpenZeppelin/openzeppelin-contracts](https://github.com/OpenZeppelin/openzeppelin-contracts)
+
+## License
+
+```
+Copyright 2018 Ocean Protocol Foundation
+
+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.
+```
\ No newline at end of file