From ae6f94bc5d3ad2df904d24710e0bbc3527ad55e2 Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Mon, 24 Jun 2019 21:11:24 +0200 Subject: [PATCH] less frightening disclaimer --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b772c42..ac8c858 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ --- -**🐲🦑 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/squid-js/issues). 🦑🐲** +**🐲🦑 THERE COULD BE DRAGONS AND SQUIDS. If you run into problems, please open up [a new issue](https://github.com/oceanprotocol/squid-js/issues). 🦑🐲** --- @@ -37,7 +37,7 @@ Start by adding the package to your dependencies: ```bash -npm i @oceanprotocol/squid --save +npm i @oceanprotocol/squid ``` The package exposes `Ocean` and `Logger` which you can import in your code like this: @@ -50,7 +50,7 @@ import { Ocean, Logger } from '@oceanprotocol/squid' const { Ocean, Logger } = require('@oceanprotocol/squid') ``` -You can then connect to a running [Keeper](https://github.com/oceanprotocol/keeper-contracts) & [Aquarius](https://github.com/oceanprotocol/aquarius) instance, e.g.: +You can then connect to running [Keeper](https://github.com/oceanprotocol/keeper-contracts), [Aquarius](https://github.com/oceanprotocol/aquarius), [Brizo](https://github.com/oceanprotocol/brizo) instances, e.g.: ```js const ocean: Ocean = await Ocean.getInstance({ @@ -69,6 +69,8 @@ const ocean: Ocean = await Ocean.getInstance({ }) ``` +For an overview of endpoint configurations making up various Ocean networks, please refer to [`.env.local.example`](https://github.com/oceanprotocol/commons/blob/master/client/.env.local.example) from commons. + ### Examples You can see how `squid-js` is used on: