oceanprotocol/ocean.js
1
0
Fork 0
mirror of https://github.com/oceanprotocol/ocean.js.git synced 2024-11-26 20:39:05 +01:00
Code Releases Activity

fixing formatting

Browse Source
This commit is contained in:
Jamie Hewitt 2021-06-14 16:10:25 +03:00
parent 9126ef19b4
commit 3cfd3e4db4
1 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -45,12 +45,15 @@ This is in alpha state and you can expect running into problems. If you run into
- [🏛 License](#-license)
## 📚 Prerequisites
- node.js ([Install from here](https://nodejs.org/en/download/))
- Docker ([Managed as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/))
- A Unix based operating system (Mac or Linux)
### Note:
Any function that uses `getPastEvents()` will only work on Eth (see: https://github.com/oceanprotocol/ocean.js/issues/741). This includes:
- node.js ([Install from here](https://nodejs.org/en/download/))
- Docker ([Managed as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/))
- A Unix based operating system (Mac or Linux)
### Note
Any function that uses `getPastEvents()` will only work on Eth (see: <https://github.com/oceanprotocol/ocean.js/issues/741>). This includes:
- searchPoolforDT()
- getPoolsbyCreator()
- getPoolSharesByAddress()
@ -60,6 +63,7 @@ Any function that uses `getPastEvents()` will only work on Eth (see: https://git
- getExchangesbyCreator()
- getExchangeSwaps()
- getAllExchangesSwaps()
## 🏗 Installation
```bash
@ -87,9 +91,10 @@ async function init() {
return ocean
}
```
### Beginners Guide
This introduction is aimed at developers who are completely new to blockchain, no coding experience is required.
This introduction is aimed at developers who are completely new to blockchain, no coding experience is required.
[Go to beginners guide](docs/beginners_guide.md)
@ -107,15 +112,15 @@ This batteries-included flow includes metadata, multiple services for one datato
### 📖 Learn more
- [Get test OCEAN](docs/get-test-OCEAN.md) - from rinkeby
- [Understand config parameters](docs/parameters.md) - envvars vs files
- [Learn about off-chain services](docs/services.md) - Ocean Provider for data services, Aquarius metadata store
- [Learn about wallets](docs/wallets.md) - on generating, storing, and accessing private keys
- [Get an overview of ocean.js](docs/overview.md) - key modules and functions
- [Get test OCEAN](docs/get-test-OCEAN.md) - from rinkeby
- [Understand config parameters](docs/parameters.md) - envvars vs files
- [Learn about off-chain services](docs/services.md) - Ocean Provider for data services, Aquarius metadata store
- [Learn about wallets](docs/wallets.md) - on generating, storing, and accessing private keys
- [Get an overview of ocean.js](docs/overview.md) - key modules and functions
If you have any difficulties with the quickstarts, or if you have further questions about how to use ocean.js please reach out to us on [Discord](https://discord.gg/TnXjkR5).
If you notice any bugs or issues with Ocean.js please [open an issue on github](https://github.com/oceanprotocol/ocean.js/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
If you notice any bugs or issues with Ocean.js please [open an issue on github](https://github.com/oceanprotocol/ocean.js/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
## 🦑 Development
@ -156,11 +161,13 @@ cd barge
You can then proceed to run in another terminal.
Let ocean.js know where to pickup the smartcontract addresses:
```
export ADDRESS_FILE="${HOME}/.ocean/ocean-contracts/artifacts/address.json"
```
Build metadata:
```
npm run build
```