Skip to content

Commit

Permalink
doc(sdk) update readme with badge maintainer instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mt-dfrey committed Oct 5, 2023
1 parent b18603d commit 7fd3f27
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
@@ -1,5 +1,38 @@
# Moneytree Link JavaScript SDK

[![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)

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.

Read the [documentation](docs/README.md) for more information.
## For SDK Users

Read the [documentation](https://moneytree.github.io/mt-link-javascript-sdk/) for more information.

## For SDK Maintainers

```bash
yarn install
yarn lint # runs eslint
yarn test # runs all the tests
yarn build # bundles the library
```

There is a minimal sample application in the `sample` directory.

### Documentation

```bash
yarn build:docs # bundles the documentation
yarn start:docs # Serves the documentation
```

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`).

### Publishing

```bash
npm version
# after merging the new version to master
npm login
npm publish
```

0 comments on commit 7fd3f27

Please sign in to comment.