docs: add description

skarab42 · Jan 9, 2024 · da51d1f · da51d1f
1 parent 8254424
commit da51d1f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # @skarab/eslint-staged
 
-This package provides a CLI tool (`eslint-staged`) designed to run ESLint on specific files, considering the files in `.eslintignore`.
+Refines [lint-staged] functionality, enforcing strict adherence to ESLint's ignored file configurations.
+
+This package provides a CLI tool (`eslint-staged`) designed to run ESLint on staged files, considering the files in `.eslintignore` and `ignorePatterns`.
 
 It resolves the [common issue] ([1], [2]) where [lint-staged] pass files ignored by ESLint.
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@skarab/eslint-staged",
-  "description": "My skaffolded project",
+  "description": "Refines lint-staged functionality, enforcing adherence to ESLint's ignored file configurations.",
   "version": "0.0.0-development",
   "license": "MIT",
   "author": {