chore: add a description for npm for all packages. (#15026)

prisma · Aug 26, 2022 · c511811 · c511811
1 parent fea4a6d
commit c511811
Show file tree

Hide file tree

Showing 13 changed files with 19 additions and 6 deletions.
diff --git a/packages/debug/package.json b/packages/debug/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@prisma/debug",
   "version": "0.0.0",
+  "description": "This package is intended for Prisma's internal use",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",

diff --git a/packages/engine-core/package.json b/packages/engine-core/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@prisma/engine-core",
   "version": "0.0.0",
+  "description": "This package is intended for Prisma's internal use",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

diff --git a/packages/engines/README.md b/packages/engines/README.md
@@ -1,8 +1,11 @@
 # `@prisma/engines`
 
-This package ships the Prisma Engines, namely the Query Engine, Migration Engine, Introspection Engine and Prisma Format.
-The postinstall hook of this package downloads all engines available for the current platform are from the Prisma CDN.
-The engines to be downloaded are directly determined by the version of its `@prisma/engines-version` dependency.
+⚠️ **Warning**: This package is intended for Prisma's internal use.
+Its release cycle does not follow SemVer, which means we might release breaking changes (change APIs, remove functionality) without any prior warning.
+
+The postinstall hook of this package downloads all Prisma engines available for the current platform, namely the Query Engine, Migration Engine, Introspection Engine and Prisma Format from the Prisma CDN.
+
+The engines version to be downloaded are directly determined by the version of its `@prisma/engines-version` dependency.
 
 You should probably not use this package directly, but instead use one of these:
 

diff --git a/packages/engines/package.json b/packages/engines/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@prisma/engines",
   "version": "0.0.0",
+  "description": "This package is intended for Prisma's internal use",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",

diff --git a/packages/fetch-engine/package.json b/packages/fetch-engine/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@prisma/fetch-engine",
   "version": "0.0.0",
+  "description": "This package is intended for Prisma's internal use",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",

diff --git a/packages/generator-helper/package.json b/packages/generator-helper/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@prisma/generator-helper",
   "version": "0.0.0",
+  "description": "This package is intended for Prisma's internal use",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "typings": "dist/index.d.ts",

diff --git a/packages/get-platform/package.json b/packages/get-platform/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@prisma/get-platform",
   "version": "0.0.0",
+  "description": "This package is intended for Prisma's internal use",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",

diff --git a/packages/instrumentation/README.md b/packages/instrumentation/README.md
@@ -2,7 +2,7 @@
 
 [![npm version](https://img.shields.io/npm/v/@prisma/instrumentation.svg?style=flat)](https://www.npmjs.com/package/@prisma/instrumentation) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/prisma/prisma/blob/main/CONTRIBUTING.md) [![GitHub license](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/prisma/prisma/blob/main/LICENSE) [![Slack](https://img.shields.io/badge/chat-on%20slack-blue.svg)](https://slack.prisma.io/)
 
-[OTEL - OpenTelemetry](https://opentelemetry.io/) compliant instrumentation for Prisma.
+[OTEL - OpenTelemetry](https://opentelemetry.io/) compliant instrumentation for Prisma Client.
 
 ⚠️ **Warning**: This package is provided as part of the `tracing` Preview Feature
 Its release cycle does not follow SemVer, which means we might release breaking changes (change APIs, remove functionality) without any prior warning.

diff --git a/packages/instrumentation/package.json b/packages/instrumentation/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@prisma/instrumentation",
   "version": "0.0.0",
+  "description": "OpenTelemetry compliant instrumentation for Prisma Client",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",

diff --git a/packages/internals/package.json b/packages/internals/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@prisma/internals",
   "version": "0.0.0",
+  "description": "This package is intended for Prisma's internal use",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": {

diff --git a/packages/migrate/package.json b/packages/migrate/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@prisma/migrate",
   "version": "0.0.0",
+  "description": "This package is intended for Prisma's internal use",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": {

diff --git a/packages/react-prisma/README.md b/packages/react-prisma/README.md
@@ -3,9 +3,9 @@
 This package allows using the Prisma Client in a React Server Component.
 It is a thin wrapper around `@prisma/client`.
 
-**This is highly experimental. Don't use this in any real application**
-
+⚠️ **Warning**: **This is highly experimental. Don't use this in any real application**
 We just publish this early for demonstration purposes.
+Its release cycle does not follow SemVer, which means we might release breaking changes (change APIs, remove functionality) without any prior warning.
 
 # This is unstable
 

diff --git a/packages/react-prisma/package.json b/packages/react-prisma/package.json
@@ -1,6 +1,7 @@
 {
   "name": "react-prisma",
   "version": "0.0.5",
+  "description": "Experimental wrapper around `@prisma/client` for React Server Components",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",