chore: update READMEs with status and dist tag info (#9328)

emberjs · Apr 5, 2024 · d3281fd · d3281fd
1 parent 221b046
commit d3281fd
Show file tree

Hide file tree

Showing 23 changed files with 243 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -31,6 +31,14 @@ Wrangle your application's data management with scalable patterns for developer
 - 🐹 Built with ♥️ by [Ember](https://emberjs.com)
 - ⚛️ Supports any API: `GraphQL` `JSON:API` `REST` `tRPC` ...bespoke or a mix
 
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/ember-data/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/ember-data/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/ember-data/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/ember-data/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/ember-data/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
 ### 📖 On This Page
 
 - [Overview](#overview)

diff --git a/packages/-ember-data/README.md b/packages/-ember-data/README.md
@@ -31,6 +31,14 @@ Wrangle your application's data management with scalable patterns for developer
 - 🐹 Built with ♥️ by [Ember](https://emberjs.com)
 - ⚛️ Supports any API: `GraphQL` `JSON:API` `REST` `tRPC` ...bespoke or a mix
 
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/ember-data/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/ember-data/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/ember-data/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/ember-data/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/ember-data/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
 ### 📖 On This Page
 
 - [Overview](#overview)

diff --git a/packages/active-record/README.md b/packages/active-record/README.md
@@ -27,6 +27,15 @@ Install using your javascript package manager of choice. For instance with [pnpm
 pnpm add @ember-data/active-record
 ```
 
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/active-record/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/active-record/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/active-record/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/active-record/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/active-record/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+
 ## Getting Started
 
 If this package is how you are first learning about EmberData, we recommend starting with learning about the [Store](https://github.com/emberjs/data/blob/main/packages/store/README.md) and [Requests](https://github.com/emberjs/data/blob/main/packages/request/README.md)

diff --git a/packages/adapter/README.md b/packages/adapter/README.md
@@ -31,6 +31,15 @@ If installing `@ember-data/` packages individually install using your javascript
 pnpm add @ember-data/adapter
 ```
 
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/adapter/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/adapter/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/adapter/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/adapter/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/adapter/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+
 ## 🚀 Setup
 
 If using `ember-data` no additional setup is necesssary.

diff --git a/packages/core-types/README.md b/packages/core-types/README.md
@@ -16,6 +16,21 @@
 <h3 align="center">🛸 @warp-drive/core-types</h3>
 <p align="center">Provides core types, type utils and constants for WarpDrive and EmberData</p>
 
+## Installation
+
+```cli
+pnpm install @warp-drive/core-types
+```
+
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40warp-drive/core-types/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40warp-drive/core-types/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40warp-drive/core-types/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40warp-drive/core-types/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40warp-drive/core-types/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+
 ### ♥️ Credits
 
  <details>

diff --git a/packages/debug/README.md b/packages/debug/README.md
@@ -10,6 +10,16 @@ Provides ember-inspector support for Ember apps built with EmberData
 pnpm install @ember-data/debug
 ```
 
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/debug/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/debug/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/debug/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/debug/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/debug/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+
+
 ## Usage
 
 ### removing inspector support in production

diff --git a/packages/diagnostic/README.md b/packages/diagnostic/README.md
@@ -16,14 +16,24 @@
 <h3 align="center">⚡️ A Lightweight Modern Test Runner</h3>
 <p align="center">QUnit Compatible (mostly! 🙈)</p>
 
-> ⚠️ Private
-
-This package may currently only be used within EmberData. A public version is coming soon 💜
+## Installation
 
 ```cli
 pnpm install @warp-drive/diagnostic
 ```
 
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40warp-drive/diagnostic/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40warp-drive/diagnostic/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40warp-drive/diagnostic/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40warp-drive/diagnostic/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40warp-drive/diagnostic/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+---
+
+## About
+
 **@warp-drive/** *diagnostic* is a ground-up revisiting of the APIs [QUnit](https://qunitjs.com/) popularized and [Ember](https://github.com/emberjs/ember-qunit) polished.
 
 - 💜 Fully Typed

diff --git a/packages/ember/README.md b/packages/ember/README.md
@@ -22,6 +22,14 @@
 pnpm install @warp-drive/ember
 ```
 
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40warp-drive%2Fember/canary?label=@canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40warp-drive%2Fember/bet?label=@beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40warp-drive%2Fember/latest?label=@latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40warp-drive%2Fember/lts?label=@lts&color=0096FF)
+- ![NPM LTS-4-12 Version](https://img.shields.io/npm/v/%40warp-drive%2Fember/lts-4-12?label=@lts-4-12&color=bbbbbb)
+
 ## About
 
 This library provides reactive utilities for working with promises and requests, building over these primitives to provide functions and components that enable you to build robust performant apps with elegant control flow

diff --git a/packages/graph/README.md b/packages/graph/README.md
@@ -28,3 +28,11 @@ Install using your javascript package manager of choice. For instance with [pnpm
 ```no-highlight
 pnpm add @ember-data/graph
 ```
+
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/graph/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/graph/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/graph/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/graph/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/graph/lts-4-12?label=%40lts-4-12&color=bbbbbb)
diff --git a/packages/holodeck/README.md b/packages/holodeck/README.md
@@ -40,16 +40,21 @@
 
 ## Installation
 
-> ⚠️ Private
-
-This package may currently only be used within EmberData. A public version is coming soon 💜
 
 ```json
-"devDependencies": {
-  "@warp-drive/holodeck": "workspace:*"
-}
+pnpm install @warp-drive/holodeck
 ```
 
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40warp-drive/holodeck/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40warp-drive/holodeck/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40warp-drive/holodeck/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40warp-drive/holodeck/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40warp-drive/holodeck/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+
+
 ## Usage
 #### Mocking from Within a Test
 

diff --git a/packages/json-api/README.md b/packages/json-api/README.md
@@ -27,6 +27,15 @@ Install using your javascript package manager of choice. For instance with [pnpm
 pnpm add @ember-data/json-api
 ```
 
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/json-api/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/json-api/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/json-api/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/json-api/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/json-api/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+
 ## Getting Started
 
 If this package is how you are first learning about EmberData, we recommend starting with learning about the [Store](https://github.com/emberjs/data/blob/main/packages/store/README.md) and [Requests](https://github.com/emberjs/data/blob/main/packages/request/README.md)

diff --git a/packages/legacy-compat/README.md b/packages/legacy-compat/README.md
@@ -24,3 +24,11 @@ Install using your javascript package manager of choice. For instance with [pnpm
 ```no-highlight
 pnpm add @ember-data/legacy-compat
 ```
+
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/legacy-compat/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/legacy-compat/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/legacy-compat/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/legacy-compat/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/legacy-compat/lts-4-12?label=%40lts-4-12&color=bbbbbb)
diff --git a/packages/model/README.md b/packages/model/README.md
@@ -15,6 +15,25 @@
     />
 </p>
 
+<p align="center">Runtime Classes for use as a Schema Source and Resource Presentation for EmberData</p>
+
+## Installation
+
+Install using your javascript package manager of choice. For instance with [pnpm](https://pnpm.io/)
+
+```no-highlight
+pnpm add @ember-data/model
+```
+
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/model/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/model/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/model/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/model/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/model/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+
 <p align="center">Provides a Presentation Model for resource data in an EmberData Cache</p>
 
 This package implements the EmberData Store's `instantiateRecord` and `teardownRecord` hooks

diff --git a/packages/request-utils/README.md b/packages/request-utils/README.md
@@ -28,6 +28,16 @@ Install using your javascript package manager of choice. For instance with [pnpm
 ```no-highlight
 pnpm add @ember-data/request-utils
 ```
+
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/request-utils/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/request-utils/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/request-utils/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/request-utils/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/request-utils/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+
 ## Utils
 
 - [buildBaseUrl]()

diff --git a/packages/request/README.md b/packages/request/README.md
@@ -42,6 +42,15 @@ Install using your javascript package manager of choice. For instance with [pnpm
 pnpm add @ember-data/request
 ```
 
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/request/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/request/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/request/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/request/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/request/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+
 ## 🚀 Basic Usage
 
 A `RequestManager` provides a request/response flow in which configured handlers are successively given the opportunity to handle, modify, or pass-along a request.

diff --git a/packages/rest/README.md b/packages/rest/README.md
@@ -27,6 +27,15 @@ Install using your javascript package manager of choice. For instance with [pnpm
 pnpm add @ember-data/rest
 ```
 
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/rest/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/rest/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/rest/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/rest/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/rest/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+
 ## Getting Started
 
 If this package is how you are first learning about EmberData, we recommend starting with learning about the [Store](https://github.com/emberjs/data/blob/main/packages/store/README.md) and [Requests](https://github.com/emberjs/data/blob/main/packages/request/README.md)

diff --git a/packages/schema-record/README.md b/packages/schema-record/README.md
@@ -29,9 +29,18 @@ This package provides presentation capabilities for your resource data. It works
 
 ## Installation
 
-> ⚠️ Private
+```cli
+pnpm install @warp-drive/schema-record
+```
+
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40warp-drive/schema-record/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40warp-drive/schema-record/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40warp-drive/schema-record/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40warp-drive/schema-record/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40warp-drive/schema-record/lts-4-12?label=%40lts-4-12&color=bbbbbb)
 
-This package may currently only be used within EmberData. A public version is coming soon 💜
 
 #### 🔜 Soon 
 Install using your javascript package manager of choice. For instance with [pnpm](https://pnpm.io/)

diff --git a/packages/schema-record/package.json b/packages/schema-record/package.json
@@ -1,8 +1,7 @@
 {
   "name": "@warp-drive/schema-record",
   "version": "0.0.0-alpha.37",
-  "private": true,
-  "description": "Never write a Model again",
+  "description": "Schema Driven Resource Presentation for WarpDrive and EmberData",
   "keywords": [
     "ember-addon"
   ],

diff --git a/packages/schema/README.md b/packages/schema/README.md
@@ -34,6 +34,20 @@ Its like GraphQL, RPC, or Protobuf... but for anything!
 
 This package may currently only be used within EmberData. A public version is coming soon 💜
 
+## Installation
+
+```cli
+pnpm install @warp-drive/schema
+```
+
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40warp-drive/schema/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40warp-drive/schema/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40warp-drive/schema/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40warp-drive/schema/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40warp-drive/schema/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
 #### 🔜 Soon 
 
 Scaffold the schema for a `User` resource

diff --git a/packages/serializer/README.md b/packages/serializer/README.md
@@ -31,6 +31,15 @@ If installing `@ember-data/` packages individually install using your javascript
 pnpm add @ember-data/serializer
 ```
 
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/serializer/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/serializer/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/serializer/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/serializer/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/serializer/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
+
 ## 🚀 Setup
 
 If using `ember-data` no additional setup is necesssary.

diff --git a/packages/store/README.md b/packages/store/README.md
@@ -55,6 +55,14 @@ pnpm add @ember-data/store
 
 After installing you will want to configure your first `Store`. Read more below for how to create and configure stores for your application.
 
+**Tagged Releases**
+
+- ![NPM Canary Version](https://img.shields.io/npm/v/%40ember-data/store/canary?label=%40canary&color=FFBF00)
+- ![NPM Beta Version](https://img.shields.io/npm/v/%40ember-data/store/beta?label=%40beta&color=ff00ff)
+- ![NPM Stable Version](https://img.shields.io/npm/v/%40ember-data/store/latest?label=%40latest&color=90EE90)
+- ![NPM LTS Version](https://img.shields.io/npm/v/%40ember-data/store/lts?label=%40lts&color=0096FF)
+- ![NPM LTS 4.12 Version](https://img.shields.io/npm/v/%40ember-data/store/lts-4-12?label=%40lts-4-12&color=bbbbbb)
+
 
 ## 🔨 Creating A Store