docs: 📝 add package descriptions and update links to the lint-config …

…repository
shlroland · Oct 11, 2024 · 5b590c9 · 5b590c9
1 parent 3e15f19
commit 5b590c9
Show file tree

Hide file tree

Showing 12 changed files with 26 additions and 10 deletions.
diff --git a/.changeset/hungry-baboons-drive.md b/.changeset/hungry-baboons-drive.md
@@ -0,0 +1,10 @@
+---
+"@shlroland/lint-staged": patch
+"@shlroland/cz-config": patch
+"@shlroland/prettier-config": patch
+"@shlroland/eslint-config": patch
+"@shlroland/husky-config": patch
+"@shlroland/lint-cli": patch
+---
+
+Perfect package instructions
diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -1 +1 @@
-see [README.md](../../README.md#Wizard_Setup)
+see [README.md](https://github.com/shlroland/lint-config#wizard-setup)
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -5,6 +5,7 @@
   "description": "Setup Wizard for lint tools",
   "author": "shlroland <shlroland1995@gmail.com> (https://github.com/shlroland/)",
   "license": "MIT",
+  "repository": "https://github.com/shlroland/lint-config",
   "keywords": [
     "lint",
     "setup",

diff --git a/packages/cz-config/README.md b/packages/cz-config/README.md
@@ -1 +1 @@
-see [README.md](<../../README.md#cz(czg)_+_commitlint>)
+see [README.md](<https://github.com/shlroland/lint-config#cz(czg)_+_commitlint>)
diff --git a/packages/cz-config/package.json b/packages/cz-config/package.json
@@ -2,9 +2,10 @@
   "name": "@shlroland/cz-config",
   "type": "module",
   "version": "2.0.1",
-  "description": "",
+  "description": "cz config for @shlroland/lint-config",
   "author": "shlroland <shlroland1995@gmail.com> (https://github.com/shlroland/)",
   "license": "MIT",
+  "repository": "https://github.com/shlroland/lint-config",
   "keywords": [],
   "exports": {
     ".": {

diff --git a/packages/eslint/README.md b/packages/eslint/README.md
@@ -1 +1 @@
-see [README.md](../../README.md#eslint)
+see [README.md](https://github.com/shlroland/lint-config#eslint)
diff --git a/packages/eslint/package.json b/packages/eslint/package.json
@@ -2,9 +2,10 @@
   "name": "@shlroland/eslint-config",
   "type": "module",
   "version": "2.0.0",
-  "description": "",
+  "description": "eslint config for @shlroland/lint-config",
   "author": "shlroland <shlroland1995@gmail.com> (https://github.com/shlroland/)",
   "license": "MIT",
+  "repository": "https://github.com/shlroland/lint-config",
   "keywords": [],
   "exports": {
     ".": {

diff --git a/packages/husky/package.json b/packages/husky/package.json
@@ -2,9 +2,10 @@
   "name": "@shlroland/husky-config",
   "type": "module",
   "version": "2.0.0",
-  "description": "",
+  "description": "husky config for @shlroland/lint-config",
   "author": "shlroland <shlroland1995@gmail.com> (https://github.com/shlroland/)",
   "license": "MIT",
+  "repository": "https://github.com/shlroland/lint-config",
   "keywords": [],
   "exports": {
     ".": "./lib/index.js"

diff --git a/packages/lint-staged/README.md b/packages/lint-staged/README.md
@@ -1 +1 @@
-see [README.md](../../README.md#lint-staged)
+see [README.md](https://github.com/shlroland/lint-config#lint-staged)
diff --git a/packages/lint-staged/package.json b/packages/lint-staged/package.json
@@ -2,9 +2,10 @@
   "name": "@shlroland/lint-staged",
   "type": "module",
   "version": "3.0.0",
-  "description": "",
+  "description": "lint-staged config for @shlroland/lint-config",
   "author": "shlroland <shlroland1995@gmail.com> (https://github.com/shlroland/)",
   "license": "MIT",
+  "repository": "https://github.com/shlroland/lint-config",
   "keywords": [],
   "exports": {
     ".": {

diff --git a/packages/prettier/README.md b/packages/prettier/README.md
@@ -1 +1 @@
-see [README.md](../../README.md#prettier)
+see [README.md](https://github.com/shlroland/lint-config#prettier)
diff --git a/packages/prettier/package.json b/packages/prettier/package.json
@@ -2,9 +2,10 @@
   "name": "@shlroland/prettier-config",
   "type": "module",
   "version": "2.0.0",
-  "description": "",
+  "description": "prettier config for @shlroland/lint-config",
   "author": "shlroland <shlroland1995@gmail.com> (https://github.com/shlroland/)",
   "license": "MIT",
+  "repository": "https://github.com/shlroland/lint-config",
   "keywords": [],
   "exports": {
     ".": {
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		see [README.md](../../README.md#Wizard_Setup)
		see [README.md](https://github.com/shlroland/lint-config#wizard-setup)
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		see [README.md](<../../README.md#cz(czg)_+_commitlint>)
		see [README.md](<https://github.com/shlroland/lint-config#cz(czg)_+_commitlint>)
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		see [README.md](../../README.md#eslint)
		see [README.md](https://github.com/shlroland/lint-config#eslint)
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		see [README.md](../../README.md#lint-staged)
		see [README.md](https://github.com/shlroland/lint-config#lint-staged)
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		see [README.md](../../README.md#prettier)
		see [README.md](https://github.com/shlroland/lint-config#prettier)