@engrate/components 0.0.1 → 0.0.3
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.
- package/README.md +17 -9
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ A React component library built with Tailwind CSS, following Engrate's brand gui
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install
|
|
8
|
+
npm install @engrate/components
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
### Peer Dependencies
|
|
@@ -89,17 +89,17 @@ npm install
|
|
|
89
89
|
```
|
|
90
90
|
src/
|
|
91
91
|
├── components/
|
|
92
|
-
│ ├── ui/
|
|
93
|
-
│ └── layout/
|
|
92
|
+
│ ├── ui/ # Base UI components (Button, etc.)
|
|
93
|
+
│ └── layout/ # Layout components
|
|
94
94
|
├── lib/
|
|
95
|
-
│ └── utils.ts
|
|
95
|
+
│ └── utils.ts # Utility functions (cn, etc.)
|
|
96
96
|
├── styles/
|
|
97
|
-
│ ├── fonts.css
|
|
98
|
-
│ └── index.css
|
|
97
|
+
│ ├── fonts.css # @font-face declarations
|
|
98
|
+
│ └── index.css # Tailwind entry point
|
|
99
99
|
├── test/
|
|
100
|
-
│ └── setup.ts
|
|
101
|
-
├── tailwind.preset.ts
|
|
102
|
-
└── index.ts
|
|
100
|
+
│ └── setup.ts # Test configuration
|
|
101
|
+
├── tailwind.preset.ts # Exportable design tokens
|
|
102
|
+
└── index.ts # Main entry point
|
|
103
103
|
```
|
|
104
104
|
|
|
105
105
|
### Adding a Component
|
|
@@ -142,6 +142,14 @@ This library follows Engrate's brand guidelines:
|
|
|
142
142
|
- **No bold fonts**: Use Regular weight only (Medium for emphasis)
|
|
143
143
|
- **Left-aligned text**: Default alignment
|
|
144
144
|
|
|
145
|
+
## Publishing to NPM
|
|
146
|
+
|
|
147
|
+
Make sure you have access to the @engrate org in NPM and then run:
|
|
148
|
+
|
|
149
|
+
```
|
|
150
|
+
npm publish --access public
|
|
151
|
+
```
|
|
152
|
+
|
|
145
153
|
## License
|
|
146
154
|
|
|
147
155
|
MIT License
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@engrate/components",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"description": "Engrate Component Library",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/eg-components.cjs.js",
|
|
@@ -39,8 +39,7 @@
|
|
|
39
39
|
"format": "prettier --write .",
|
|
40
40
|
"format:check": "prettier --check .",
|
|
41
41
|
"typecheck": "tsc --noEmit",
|
|
42
|
-
"verify": "npm run test:run && npm run lint:fix && npm run format:check && npm run typecheck"
|
|
43
|
-
"publish": "npm publish --access public"
|
|
42
|
+
"verify": "npm run test:run && npm run lint:fix && npm run format:check && npm run typecheck"
|
|
44
43
|
},
|
|
45
44
|
"repository": {
|
|
46
45
|
"type": "git",
|