Skip to content

Commit 7fd3f27

Browse files
committed
doc(sdk) update readme with badge maintainer instructions
1 parent b18603d commit 7fd3f27

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,38 @@
11
# Moneytree Link JavaScript SDK
22

3+
[![NPM Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F%40moneytree%2Fmt-link-javascript-sdk&query=%24%5B'dist-tags'%5D%5B'latest'%5D&logo=npm&label=%40moneytree%2Fmt-link-javascript-sdk&color=14BF31)](https://www.npmjs.com/package/@moneytree/mt-link-javascript-sdk)
4+
35
This is a library for browser client to help you integrate Moneytree tools such as My Account and the Vault without having to do worry about the complex configurations.
46

5-
Read the [documentation](docs/README.md) for more information.
7+
## For SDK Users
8+
9+
Read the [documentation](https://moneytree.github.io/mt-link-javascript-sdk/) for more information.
10+
11+
## For SDK Maintainers
12+
13+
```bash
14+
yarn install
15+
yarn lint # runs eslint
16+
yarn test # runs all the tests
17+
yarn build # bundles the library
18+
```
19+
20+
There is a minimal sample application in the `sample` directory.
21+
22+
### Documentation
23+
24+
```bash
25+
yarn build:docs # bundles the documentation
26+
yarn start:docs # Serves the documentation
27+
```
28+
29+
We use [docsify](https://docsify.js.org/) to serve the documentation landing page (`docs/README.md`) and [typedoc](https://typedoc.org/) to generate the API documentation (`docs/types`).
30+
31+
### Publishing
32+
33+
```bash
34+
npm version
35+
# after merging the new version to master
36+
npm login
37+
npm publish
38+
```

0 commit comments

Comments
 (0)