From f3941a1c0046b283515bbb738202135cba2cfdce Mon Sep 17 00:00:00 2001 From: Akshay Date: Thu, 10 Jun 2021 09:34:49 +0200 Subject: [PATCH] Feature: Improve readme file for rendering in read-the-docs (#127) * Feature: Improve readme file for rendering in read-the-docs * Feature: Change emojis to fix the header link issue in read the docs --- .docignore | 1 + README.md | 25 +++++++++++++++++-------- 2 files changed, 18 insertions(+), 8 deletions(-) create mode 100644 .docignore diff --git a/.docignore b/.docignore new file mode 100644 index 0000000..83b6947 --- /dev/null +++ b/.docignore @@ -0,0 +1 @@ +CHANGELOG.md \ No newline at end of file diff --git a/README.md b/README.md index cc6f079..c3696a5 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,23 @@ > ๐Ÿฆ€ Ocean Protocol Subgraph +
+ [![Build Status](https://github.com/oceanprotocol/ocean-subgraph/workflows/CI/badge.svg)](https://github.com/oceanprotocol/ocean-subgraph/actions) + +
+ +
+ [![js oceanprotocol](https://img.shields.io/badge/js-oceanprotocol-7b1173.svg)](https://github.com/oceanprotocol/eslint-config-oceanprotocol) +
+ - [๐Ÿ„ Get Started](#-get-started) -- [๐Ÿงถ Example Queries](#-example-queries) -- [๐Ÿฆ‘ Development](#-development) -- [๐Ÿฆ‘ Development on barge](#-development-on-barge) -- [๐Ÿงช Testing](#-testing) +- [โ›ต Example Queries](#-example-queries) +- [๐ŸŠ Development](#-development) +- [๐ŸŠ Development on barge](#-development-on-barge) +- [๐Ÿ” Testing](#-testing) - [โœจ Code Style](#-code-style) - [๐Ÿ›ณ Releases](#๏ธ-releases) - [โฌ†๏ธ Deployment](#๏ธ-deployment) @@ -25,7 +34,7 @@ This subgraph is deployed under `/subgraphs/name/oceanprotocol/ocean-subgraph/` - [subgraph.ropsten.oceanprotocol.com](https://subgraph.ropsten.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) - [subgraph.rinkeby.oceanprotocol.com](https://subgraph.rinkeby.oceanprotocol.com/subgraphs/name/oceanprotocol/ocean-subgraph/graphql) -## ๐Ÿงถ Example Queries +## โ›ต Example Queries **All pools** @@ -74,7 +83,7 @@ This subgraph is deployed under `/subgraphs/name/oceanprotocol/ocean-subgraph/` > Note: all ETH addresses like `$userAddress` in above example need to be passed in lowercase. -## ๐Ÿฆ‘ Development +## ๐ŸŠ Development First, clone the repo and install dependencies: @@ -105,7 +114,7 @@ The default network for development is set to Rinkeby. If you want to switch to You now have a local graph-node running and can start deploying your changes to it. To do so, follow the [Deployment instructions](#๏ธ-deployment). -## ๐Ÿฆ‘ Development on Barge +## ๐ŸŠ Development on Barge 1. Clone [barge](https://github.com/oceanprotocol/barge) and run it in another terminal: @@ -150,7 +159,7 @@ You now have a local graph-node running on http://localhost:9000 -## ๐Ÿงช Testing +## ๐Ÿ” Testing - Please note: the `npm run test` command is currently not working due to [this issue](https://github.com/graphprotocol/graph-ts/issues/113).