docs: add readme

danielwaltz · Dec 7, 2024 · 3dce66a · 3dce66a
1 parent fe5cde5
commit 3dce66a
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,27 @@
+# @danielwaltz/eslint-config
+
+My personal ESLint configuration.
+
+## Installation
+
+```shell
+npx -y nypm@latest i -D @danielwaltz/eslint-config
+```
+
+## Usage
+
+```mjs
+import { danielwaltz } from "@danielwaltz/eslint-config";
+
+export default danielwaltz();
+```
+
+## Customization
+
+```mjs
+import { danielwaltz } from "@danielwaltz/eslint-config";
+
+export default danielwaltz([...customRules])
+  .prepend([...prependRules])
+  .append([...appendRules]);
+```