Skip to content

Commit

Permalink
Tidy README
Browse files Browse the repository at this point in the history
  • Loading branch information
m0ar committed Nov 2, 2023
1 parent ea4bef4 commit ead6fc5
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ This repo contains a reference implementation for the next generation of the pro

By default, the application runs a local Ceramic/ComposeDB node with the bundled IPFS server, uses the `inmemory` network for anchoring, and writes all data and logs to `local-data`.

The protocol documentation can be found [here](pls-replace-me)!

## Getting started

1. Install dependencies:
Expand All @@ -28,8 +30,9 @@ Now you can open [http://localhost:5001](http://localhost:5001) for the GraphiQL

## Test suite

There is a test suite running through API operations demonstrating the functional protocol
requirements. This clones your user configuration, but changes storage to `local-data/ceramic-test` not to interfere with prepopulated data. Do make sure to stop `npm run dev` before executing tests.
There is a test suite running through API operations demonstrating the functional protocol requirements, by generating random DID's and performing create and mutation operations. Before each run, it will remove the remains of the last test execution.

The test setup clones your user configuration, but changes storage to `local-data/ceramic-test` not to interfere with prepopulated data. It will refuse to run if `npm run dev` is already active.

```bash
make test
Expand Down

0 comments on commit ead6fc5

Please sign in to comment.