ryuu-client 4.3.2 → 4.3.3

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [4.3.3](https://github.com/DomoApps/domoapps-client/compare/v4.3.3-beta.0...v4.3.3) (2023-06-26)
+
+
+### Documentation
+
+* updated license for compatibility ([4565077](https://github.com/DomoApps/domoapps-client/commit/4565077d476e53a7c3b7270da3d49e8493249be7))
+
+### [4.3.3-beta.0](https://github.com/DomoApps/domoapps-client/compare/v4.3.2...v4.3.3-beta.0) (2023-06-08)
+
+
+### Documentation
+
+* update readme ([ea7ee24](https://github.com/DomoApps/domoapps-client/commit/ea7ee2469f1ac0861dc22bc679eb07bcc5f3f7f0))
+
 ### [4.3.2](https://github.com/DomoApps/domoapps-client/compare/v4.3.2-beta.4...v4.3.2) (2023-05-15)
 
 

package/README.md

@@ -2,29 +2,45 @@
 
 The client (endpoint) repository used by Ryuu/Domo App Platform
 
+[![npm version](https://img.shields.io/npm/v/ryuu-client.svg?style=flat-square)](https://www.npmjs.org/package/ryuu-client)
+[![install size](https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=ryuu-client&query=$.install.pretty&label=install%20size&style=flat-square)](https://packagephobia.com/result?p=ryuu-client)
+[![npm downloads](https://img.shields.io/npm/dm/ryuu-client.svg?style=flat-square)](https://npm-stat.com/charts.html?package=ryuu-client)
+[![Known Vulnerabilities](https://snyk.io/test/npm/ryuu-client/badge.svg)](https://snyk.io/test/npm/ryuu-client)
+
 See the [developer docs](https://developer.domo.com/docs/dev-studio/dev-studio-overview) for instructions on how to install and use this library (almost solely as a dependancy of Ryuu/Ryuu-Proxy), as well as more information about the complete Domo App Platform.
 
-## Versioning this Library
+## Building
 
-This project utilizes [standard-version](https://github.com/conventional-changelog/standard-version).
+To build ryuu-client, run
 
-- `npm run bump` - Version bumps determined automatically via commits
-- `npm run bumpBeta` || `npm run bump -- --prerelease beta` - 4.0.x-beta.0 (if no current beta) or 4.0.0-beta.x (if current beta exists)
+```bash
+npm run build
+```
 
-## Making Changes
+All necessary files will be built/copied into the `lib` folder.
+
+## Contributing
 
 Recommended Workflow:
 
 1. Create new branch (named "DOMO-XXXXXX")
 2. Make Changes
 3. Commit Changes
-4. Make pull request
-5. Version changes and releases will be committed by package maintainers
+4. Test changes (if necessary, version a alpha/beta/tagged version, then release it)
+5. Make pull request
+6. After pull request is merged to master, bump version, then release it to npm
+
+## Versioning
 
-### Release commands (alpha/beta commands also available)
+This project utilizes [standard-version](https://github.com/conventional-changelog/standard-version).
+
+- `npm run bump` - Version bumps determined automatically via commits
+- `npm run bumpBeta` or `npm run bump -- --prerelease beta` - 4.0.x-beta.0 (if no current beta) or 4.0.0-beta.x (if current beta exists)
+
+### Releasing
+
+Versions should be released on NPM and then updated in the ryuu-cli package.json
 
 - `npm run release`
 - `npm run releaseAlpha`
 - `npm run releaseBeta`
-
-[npm package](https://www.npmjs.com/package/ryuu-client)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ryuu-client",
-  "version": "4.3.2",
+  "version": "4.3.3",
   "description": "Node client for ryuu services",
   "author": "Domo",
   "main": "lib/domoapps-client.js",
@@ -9,6 +9,7 @@
     "lib/**/*",
     "license.doc"
   ],
+  "license": "SEE LICENSE IN LICENSE",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "copy": "cp \"package.json\" \"./dist/\"",