Skip to content

Commit 51eb47d

Browse files
committed
added root readme file
1 parent 4bf15ac commit 51eb47d

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# ORGiD DID Resolver mono repository
2+
3+
## Documentation
4+
5+
[https://windingtree.github.io/org.id-sdk/](https://windingtree.github.io/org.id-sdk/)
6+
7+
## Setup
8+
9+
When you adding dependencies to your packages it is recommended to run `bootstrap` command from the root of the repository. This command will update packages dependencies.
10+
11+
```bash
12+
yarn install
13+
yarn bootstrap
14+
yarn build
15+
```
16+
17+
## Testing and linting
18+
19+
```bash
20+
yarn lint
21+
yarn test
22+
```
23+
24+
## Maintenance
25+
26+
New repository version setup (according to the SDK stake should be chosen custom `prerelease` or `major` release version type from the `lerna` CLI dialog):
27+
28+
```bash
29+
npx lerna version prerelease --yes --sign-git-commit --sign-git-tag
30+
# npx lerna version major --yes --sign-git-commit --sign-git-tag
31+
# npx lerna version minor --yes --sign-git-commit --sign-git-tag
32+
# npx lerna version patch --yes --sign-git-commit --sign-git-tag
33+
```
34+
35+
Publishing of the updated packages:
36+
37+
```bash
38+
npx lerna publish from-git
39+
```

0 commit comments

Comments
 (0)