@monerium/sdk 2.0.0 → 2.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md ADDED
@@ -0,0 +1,17 @@
1
+ # Changelog
2
+
3
+ ## [2.0.2](https://github.com/monerium/sdk/compare/v2.0.1...v2.0.2) (2023-01-05)
4
+
5
+ ### Bug Fixes
6
+
7
+ - Update TypeDocs and set workflow to run only on release ([#7](https://github.com/monerium/sdk/issues/7)) ([79c9ec9](https://github.com/monerium/sdk/commit/79c9ec9e7a68ccfb4d9debaacbc9b7b90be0fcde))
8
+
9
+ ## [2.0.1](https://github.com/monerium/sdk/compare/v2.0.0...v2.0.1) (2023-01-05)
10
+
11
+ ### Bug Fixes
12
+
13
+ - Update TypeDocs and set workflow to run only on release ([#7](https://github.com/monerium/sdk/issues/7)) ([553d765](https://github.com/monerium/sdk/commit/553d765a4a40c807de6628b31b59ddf3064f89a4))
14
+
15
+ ### Miscellaneous
16
+
17
+ - cleanup ([5aeebbc](https://github.com/monerium/sdk/commit/5aeebbca9a53592e7229168ad66849113638d070))
package/README.md CHANGED
@@ -5,6 +5,10 @@ Everything you need to interact with the Monerium API - an electronic money issu
5
5
  _This package is in development. Please make sure to check if any future updates contain commits
6
6
  that may change the behavior of your application before you upgrade._
7
7
 
8
+ [Documentation](https://monerium.github.io/sdk/)
9
+
10
+ [Code coverage](https://monerium.github.io/sdk/coverage)
11
+
8
12
  ## Installing
9
13
 
10
14
  ```sh
@@ -22,15 +26,4 @@ yarn add @monerium/sdk
22
26
 
23
27
  ## Publishing
24
28
 
25
- Update your `package.json` to next version number, and remember to tag a release.
26
-
27
- Once ready to submit your package to the NPM Registry, execute the following tasks via `yarn`:
28
-
29
- - `yarn clean` — Assure a clean build
30
- - `yarn build` — Build the package
31
-
32
- Submit your package to the registry:
33
-
34
- ```
35
- yarn publish
36
- ```
29
+ When changes are merged to the `main` branch that follows the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard, [release-please](https://github.com/googleapis/release-please) workflow creates a pull request, preparing for the next release. If kept open, the following commits will also be added to the PR. Merging that PR will create a new release, a workflow will publish it on NPM and tag it on Github.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@monerium/sdk",
3
- "version": "2.0.0",
3
+ "version": "2.0.2",
4
4
  "description": "Everything you need to interact with the Monerium API - an electronic money issuer.",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -22,7 +22,7 @@
22
22
  "scripts": {
23
23
  "build": "tsc && vite build && dts-bundle-generator --config ./dts-bundle-generator.config.ts",
24
24
  "clean": "rm -rf dist",
25
- "docs": "typedoc src/index.ts --out docs",
25
+ "docs": "typedoc --options configs/typedoc.json",
26
26
  "format": "prettier . --write",
27
27
  "lint": "eslint . --ext .ts",
28
28
  "prepare": "husky install",