Skip to content

Commit 7a80012

Browse files
ATL-6669: Delete old README and complete new one
1 parent c5a703e commit 7a80012

File tree

2 files changed

+26
-202
lines changed

2 files changed

+26
-202
lines changed

PRISM_BACKEND_README.md

Lines changed: 0 additions & 197 deletions
This file was deleted.

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,36 @@
11
# PRISM Node
22

3-
This project represents a reference implementation of the PRISM Node described in the PRISM DID method specification.
3+
This project represents a reference implementation of the PRISM Node described in the [PRISM DID method specification](https://github.com/input-output-hk/prism-did-method-spec/blob/main/w3c-spec/PRISM-method.md).
44
This code is not recommended for production environments. The project supports:
55
- the indexing of the blockchain
66
- The interpretation of the DID method events (Creation, updates and deactivation)
77
- batch submission for DID PRISM operations
88

9+
## Dependencies
10+
11+
### Install coursier
12+
13+
Coursier is a package manager through which we will install all java/scala related dependencies. Follow the [instructions](https://get-coursier.io/docs/cli-installation.html) for your operating system
14+
15+
### Install JDK 11
16+
17+
```bash
18+
cs java --jvm adopt:1.11.0-11 --setup
19+
```
20+
after that `java -version` should yield
21+
22+
```bash
23+
openjdk version "11.0.11" 2021-04-20
24+
OpenJDK Runtime Environment (build 11.0.11+9)
25+
OpenJDK 64-Bit Server VM (build 11.0.11+9, mixed mode)
26+
```
27+
28+
### Install sbt
29+
30+
```bash
31+
cs install sbt
32+
```
33+
934
## How to run
1035

1136
This implementation relays on a Postgres database, a Cardano wallet and an instance of db-sync.
@@ -183,7 +208,3 @@ run "Metals: run doctor" to see if all sub-project builds have been imported
183208

184209
run "Metals: restart build server" to restart the build server, if editor is acting weird.
185210

186-
## Known limitations
187-
188-
- This reference implementation does not support Cardano rollbacks' management
189-

0 commit comments

Comments
 (0)