@noxickon/codex 0.1.8 → 0.1.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +55 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,7 +4,62 @@ Shared ESLint and Prettier configuration for noxickon projects.
4
4
 
5
5
  ## Installation
6
6
 
7
+ ### 1. Install the config package
8
+
9
+ ```bash
7
10
  npm install --save-dev @noxickon/codex
11
+ ```
12
+
13
+ ### 2. Install required peer dependencies
14
+
15
+ **All projects (base dependencies):**
16
+
17
+ ```bash
18
+ npm install --save-dev \
19
+ eslint \
20
+ prettier \
21
+ @eslint/js \
22
+ typescript-eslint \
23
+ globals \
24
+ eslint-plugin-unicorn \
25
+ eslint-plugin-perfectionist \
26
+ eslint-plugin-sort-destructure-keys \
27
+ eslint-plugin-unused-imports \
28
+ prettier-plugin-tailwindcss
29
+ ```
30
+
31
+ **React projects (additional dependencies):**
32
+
33
+ ```bash
34
+ npm install --save-dev \
35
+ eslint-plugin-better-tailwindcss \
36
+ eslint-plugin-jsx-a11y \
37
+ eslint-plugin-react-hooks \
38
+ eslint-plugin-react-compiler \
39
+ eslint-plugin-react-refresh
40
+ ```
41
+
42
+ ### One-command installation (React projects)
43
+
44
+ ```bash
45
+ npm install --save-dev \
46
+ @noxickon/codex \
47
+ eslint \
48
+ prettier \
49
+ @eslint/js \
50
+ typescript-eslint \
51
+ globals \
52
+ eslint-plugin-unicorn \
53
+ eslint-plugin-perfectionist \
54
+ eslint-plugin-sort-destructure-keys \
55
+ eslint-plugin-unused-imports \
56
+ prettier-plugin-tailwindcss \
57
+ eslint-plugin-better-tailwindcss \
58
+ eslint-plugin-jsx-a11y \
59
+ eslint-plugin-react-hooks \
60
+ eslint-plugin-react-compiler \
61
+ eslint-plugin-react-refresh
62
+ ```
8
63
 
9
64
  ## Usage
10
65
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@noxickon/codex",
3
- "version": "0.1.8",
3
+ "version": "0.1.12",
4
4
  "author": "noxickon",
5
5
  "license": "MIT",
6
6
  "description": "Shared ESLint & Prettier configuration for noxickon projects",