docs: update descriptions

ivangabriele · Feb 7, 2024 · b94b0b6 · b94b0b6
1 parent 640a4af
commit b94b0b6
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ Check the package [README](./packages/base/README.md).
 **Package name:** `@ivangabriele/semantic-release-config-dist`.
 
 **Description:** A basic configuration for Semantic Release when using a single package repository (no monorepo) and NPM
-or Yarn as package manager **releasing** from a root `/dist` folder.
+or Yarn as package manager **fully released from a root `/dist` folder**.
 
 Check the package [README](./packages/dist/README.md).
 
@@ -45,7 +45,8 @@ Check the package [README](./packages/dist/README.md).
 
 **Package name:** `@ivangabriele/semantic-release-config-monorepo`.
 
-**Description:** A basic configuration for Semantic Release when using a monorepo and NPM or Yarn as package manager.
+**Description:** A basic configuration for Semantic Release when using a monorepo and NPM or Yarn as package manager
+with packages in a `packages/` folder.
 
 Check the package [README](./packages/monorepo/README.md).
 
@@ -55,7 +56,8 @@ Check the package [README](./packages/monorepo/README.md).
 
 **Package name:** `@ivangabriele/semantic-release-config-no-npm`.
 
-**Description:** A basic configuration for Semantic Release when using a single non-JS package repository.
+**Description:** A basic configuration for Semantic Release when using a single package repository (no monorepo) and NPM
+or Yarn as package manager **without NPM publishing**.
 
 Check the package [README](./packages/no-npm/README.md).
 

diff --git a/packages/base/README.md b/packages/base/README.md
@@ -3,7 +3,8 @@
 [![MIT License][img-license]][lnk-license] [![GitHub Check Workflow Status][img-github]][lnk-github]
 [![NPM Version][img-npm]][lnk-npm]
 
-My most commonly used Semantic Release configuration.
+A basic configuration for Semantic Release when using a single package repository (no monorepo) and NPM or Yarn as
+package manager.
 
 ## Usage
 

diff --git a/packages/base/package.json b/packages/base/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ivangabriele/semantic-release-config-base",
-  "description": "My most commonly used Semantic Release configuration.",
+  "description": "A basic semantic-release configuration.",
   "license": "MIT",
   "version": "4.1.2",
   "type": "module",

diff --git a/packages/dist/README.md b/packages/dist/README.md
@@ -3,7 +3,8 @@
 [![MIT License][img-license]][lnk-license] [![GitHub Check Workflow Status][img-github]][lnk-github]
 [![NPM Version][img-npm]][lnk-npm]
 
-My most commonly used Semantic Release configuration.
+A basic configuration for Semantic Release when using a single package repository (no monorepo) and NPM or Yarn as
+package manager **fully released from a root `/dist` folder**.
 
 ## Usage
 

diff --git a/packages/dist/package.json b/packages/dist/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ivangabriele/semantic-release-config-dist",
-  "description": "My most commonly used Semantic Release configuration.",
+  "description": "A semantic-release configuration for projects fully pubished from a dist/ folder.",
   "license": "MIT",
   "version": "4.1.2",
   "type": "module",

diff --git a/packages/monorepo/README.md b/packages/monorepo/README.md
@@ -3,7 +3,8 @@
 [![MIT License][img-license]][lnk-license] [![GitHub Check Workflow Status][img-github]][lnk-github]
 [![NPM Version][img-npm]][lnk-npm]
 
-My most commonly used Semantic Release configuration.
+A basic configuration for Semantic Release when using a monorepo and NPM or Yarn as package manager with packages in a
+`packages/` folder.
 
 ## Usage
 

diff --git a/packages/monorepo/package.json b/packages/monorepo/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ivangabriele/semantic-release-config-monorepo",
-  "description": "My most commonly used Semantic Release configuration.",
+  "description": "A semantic-release configuration for monorepo projects.",
   "license": "MIT",
   "version": "4.1.2",
   "type": "module",

diff --git a/packages/no-npm/README.md b/packages/no-npm/README.md
@@ -3,7 +3,8 @@
 [![MIT License][img-license]][lnk-license] [![GitHub Check Workflow Status][img-github]][lnk-github]
 [![NPM Version][img-npm]][lnk-npm]
 
-My most commonly used Semantic Release configuration.
+A basic configuration for Semantic Release when using a single package repository (no monorepo) and NPM or Yarn as
+package manager **without NPM publishing**.
 
 ## Usage
 

diff --git a/packages/no-npm/package.json b/packages/no-npm/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@ivangabriele/semantic-release-config-no-npm",
-  "description": "My most commonly used Semantic Release configuration.",
+  "description": "A semantic-release configuration for projects without npm publish.",
   "license": "MIT",
   "version": "4.1.2",
   "type": "module",