Skip to content

Commit

Permalink
docs: Update README [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
ankurdotb committed Nov 24, 2022
1 parent 161f84d commit 1fcb41d
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,36 @@
BDJuno (shorthand for BigDipper Juno) is the [Juno](https://github.com/forbole/juno) implementation
for [BigDipper](https://github.com/forbole/big-dipper).

It extends the custom Juno behavior by adding different handlers and custom operations to make it easier for BigDipper
showing the data inside the UI.

All the chains' data that are queried from the RPC and gRPC endpoints are stored inside
a [PostgreSQL](https://www.postgresql.org/) database on top of which [GraphQL](https://graphql.org/) APIs can then be
created using [Hasura](https://hasura.io/).

## Usage
## Features specific to cheqd

1. Indexing for [cheqd network] DIDs and Resources
2. Changes to workflows/pipelines
3. Optimised Dockerfile

## Developer guide

This section is reproduced as-is from upstream project.

### Usage

To know how to setup and run BDJuno, please refer to
the [docs website](https://docs.bigdipper.live/cosmos-based/parser/overview/).

## Testing

If you want to test the code, you can do so by running

```shell
$ make test-unit
make test-unit
```

**Note**: Requires [Docker](https://docker.com).

This will:

1. Create a Docker container running a PostgreSQL database.
2. Run all the tests using that database as support.


0 comments on commit 1fcb41d

Please sign in to comment.