@monerium/sdk 2.0.0-alpha.2 → 2.0.0

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/README.md CHANGED
@@ -8,21 +8,29 @@ that may change the behavior of your application before you upgrade._
8
8
  ## Installing
9
9
 
10
10
  ```sh
11
- # Node
11
+ # Node
12
12
  yarn add @monerium/sdk
13
13
  ```
14
14
 
15
15
  ## Developing
16
16
 
17
- If you want to make any code contributions, make sure to run the following commands before you pr
18
- them:
17
+ ## Usage
19
18
 
20
- ```sh
21
- deno fmt
22
- deno lint
23
- deno test --allow-net=api.monerium.dev
24
- ```
19
+ - `start`: Run Vite in host mode for a local development environment (not included in production build)
20
+ - `watch`: Run Vite in watch mode to detect changes to files during development
21
+ - `build`: Run Vite to build a production release distributable
25
22
 
26
23
  ## Publishing
27
24
 
28
- Tagging a release on GitHub will publish the package to NPM and Deno Land.
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
+ ```