diff --git a/.github/assets/astermd-logo.svg b/.github/assets/astermd-logo.svg new file mode 100644 index 0000000..180afd9 --- /dev/null +++ b/.github/assets/astermd-logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index d38b8b2..92b27a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [0.0.2] - 2026-11-13 + +### Changed + +- Documentation and package metadata only. + ## [0.0.1] - 2026-09-08 First public release. A port of the `astermd/vrio-client` Composer package, @@ -71,5 +77,6 @@ with the same public surface wherever TypeScript allows it. every public method and asserting URL, HTTP method, headers and request body, running on Node 22 and 24 in CI. -[Unreleased]: https://github.com/astermd/vrio-client/compare/v0.0.1...HEAD -[0.0.1]: https://github.com/astermd/vrio-client/releases/tag/v0.0.1 +[Unreleased]: https://github.com/astermd/node-vrio-client/compare/v0.0.2...HEAD +[0.0.2]: https://github.com/astermd/node-vrio-client/compare/v0.0.1...v0.0.2 +[0.0.1]: https://github.com/astermd/node-vrio-client/releases/tag/v0.0.1 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 50d95af..07c1b64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thanks for considering a contribution. This is a small, dependency-free client library with a narrow job, so most changes are small and most of the review is about invariants rather than style. -Security issues do **not** belong here: email **admin@astermd.com** and never +Security issues do **not** belong here: email **hello@astermd.com** and never open a public issue for a vulnerability. See [SECURITY.md](SECURITY.md). ## Getting set up diff --git a/LICENSE b/LICENSE index 2a0ecfd..97b7d1a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2026 AsterMD +Copyright (c) 2026 CodeClouds™ DBA AsterMD Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -19,20 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ---- - -TRADEMARK AND AFFILIATION NOTICE - -The MIT license above covers this client library's own source code only. - -"VRIO" and any related names, logos, trademarks and service marks are the -property of their respective owner, https://www.vrio.com/. This project is an -independent, unofficial client library. It is not the official VRIO Node.js SDK, -and it is not affiliated with, endorsed by, sponsored by, or supported by VRIO -or any of its subsidiaries. - -The VRIO name is used here solely in a nominative, descriptive sense to -identify the API this library communicates with. No claim of ownership over -the VRIO name, API, documentation or service is made or implied. Use of the -VRIO API remains subject to whatever agreement you have with VRIO directly. diff --git a/NOTICE.md b/NOTICE.md new file mode 100644 index 0000000..fe72351 --- /dev/null +++ b/NOTICE.md @@ -0,0 +1,16 @@ +# Notice + +The MIT license in [LICENSE](LICENSE) covers this client library's own source code only. + +## Trademark and affiliation + +"VRIO" and any related names, logos, trademarks and service marks are the +property of their respective owner, https://www.vrio.com/. This project is an +independent, unofficial client library. It is not the official VRIO Node.js SDK, +and it is not affiliated with, endorsed by, sponsored by, or supported by VRIO +or any of its subsidiaries. + +The VRIO name is used here solely in a nominative, descriptive sense to +identify the API this library communicates with. No claim of ownership over +the VRIO name, API, documentation or service is made or implied. Use of the +VRIO API remains subject to whatever agreement you have with VRIO directly. diff --git a/README.md b/README.md index b880cdb..7c68792 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +

+ AsterMD +

+ # @astermd-hq/vrio-client A small, dependency-free Node.js client for the VRIO commerce API — campaigns, @@ -8,7 +12,7 @@ logging that is redacted by default. > VRIO SDK and is not affiliated with, endorsed by or supported by VRIO. > "VRIO" and related marks belong to their owner, . The > name is used here only to identify the API this library talks to. See -> [LICENSE](LICENSE) for the full notice. +> [LICENSE](LICENSE) and [NOTICE.md](NOTICE.md) for the full notice. API reference: **** @@ -460,8 +464,8 @@ this suite makes an external network call. ## Support -Email **admin@astermd.com**, or open an issue at -. The API reference for the +Email **hello@astermd.com**, or open an issue at +. The API reference for the endpoints themselves lives in your AsterMD dashboard and at . @@ -474,8 +478,11 @@ Using this package does not by itself make your application PCI DSS, HIPAA or GDPR compliant. It is one component in your system. Scoping, encryption at rest, access control, audit logging, breach procedures and your agreements with VRIO and your payment processors remain your responsibility. For licensing or -BAA enquiries, email **admin@astermd.com**. +BAA enquiries, email **hello@astermd.com**. ## License -MIT — see [LICENSE](LICENSE), including the trademark and affiliation notice. +MIT — see [LICENSE](LICENSE). The trademark and affiliation notice is in +[NOTICE.md](NOTICE.md). + +Maintained by [AsterMD](https://www.astermd.com/). Contact: hello@astermd.com diff --git a/SECURITY.md b/SECURITY.md index 7c8a812..4ba6685 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,7 +4,7 @@ Please report security issues privately. **Do not open a public GitHub issue.** -Email **admin@astermd.com** with: +Email **hello@astermd.com** with: - a description of the issue and the impact you believe it has, - the package version and Node.js version affected, @@ -73,4 +73,4 @@ Using this package does not by itself make your application PCI DSS, HIPAA or GDPR compliant. It is one component in your system. Scoping, encryption at rest, access control, audit logging, breach procedures and your agreements with VRIO and your processors remain your responsibility. For licensing or BAA -enquiries, email **admin@astermd.com**. +enquiries, email **hello@astermd.com**. diff --git a/package-lock.json b/package-lock.json index fd43200..00a3a88 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@astermd-hq/vrio-client", - "version": "0.0.1", + "version": "0.0.2", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@astermd-hq/vrio-client", - "version": "0.0.1", + "version": "0.0.2", "license": "MIT", "devDependencies": { "@eslint/js": "^9.36.0", @@ -1748,7 +1748,7 @@ } }, "node_modules/concat-map": { - "version": "0.0.1", + "version": "0.0.2", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", "dev": true, diff --git a/package.json b/package.json index f4ceb02..f8580f2 100644 --- a/package.json +++ b/package.json @@ -1,17 +1,17 @@ { "name": "@astermd-hq/vrio-client", - "version": "0.0.1", + "version": "0.0.2", "description": "Unofficial Node.js client for the VRIO commerce API: campaigns, customers, offers, carts, discounts, orders and routes, with opt-in redacted request logging.", "license": "MIT", - "author": "AsterMD ", - "homepage": "https://github.com/astermd/npm-vrio-client#readme", + "author": "AsterMD ", + "homepage": "https://github.com/astermd/node-vrio-client#readme", "repository": { "type": "git", - "url": "git+https://github.com/astermd/npm-vrio-client.git" + "url": "git+https://github.com/astermd/node-vrio-client.git" }, "bugs": { - "url": "https://github.com/astermd/npm-vrio-client/issues", - "email": "admin@astermd.com" + "url": "https://github.com/astermd/node-vrio-client/issues", + "email": "hello@astermd.com" }, "keywords": [ "vrio", @@ -42,7 +42,8 @@ "files": [ "dist", "README.md", - "LICENSE" + "LICENSE", + "NOTICE.md" ], "sideEffects": false, "engines": {