Skip to content

Commit 1a4fa0c

Browse files
committed
docs(readme): 📝 Update package descriptions and reorder list
1 parent 7c2efbc commit 1a4fa0c

File tree

2 files changed

+103
-1
lines changed

2 files changed

+103
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ A powerful collection of utility functions, types, and composables designed to a
44

55
## 📦 Packages
66

7+
- `@zayne-labs/toolkit` - Umbrella package that includes all toolkit packages
78
- `@zayne-labs/toolkit-core` - Core utility functions and helpers
8-
- `@zayne-labs/toolkit-react` - React-specific hooks, utilities, and Zustand integrations
99
- `@zayne-labs/toolkit-type-helpers` - Advanced TypeScript type utilities and helpers
10+
- `@zayne-labs/toolkit-react` - React-specific hooks, utilities, and Zustand integrations
1011

1112
## ✨ Features
1213

@@ -17,6 +18,7 @@ A powerful collection of utility functions, types, and composables designed to a
1718
- 🎨 Zero runtime overhead for type utilities
1819
- 📦 Tree-shakeable exports
1920
- 🧪 Thoroughly tested utilities
21+
- 🔜 Support for Vue, Svelte, and Solid coming soon!
2022

2123
## 📥 Installation
2224

packages/toolkit/README.md

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# @zayne-labs/toolkit
2+
3+
A powerful collection of utility functions, types, and composables designed to accelerate development across various JavaScript/TypeScript projects. Built with modularity and type-safety in mind.
4+
5+
## 📦 Packages
6+
7+
- `@zayne-labs/toolkit` - Umbrella package that includes all toolkit packages
8+
- `@zayne-labs/toolkit-core` - Core utility functions and helpers
9+
- `@zayne-labs/toolkit-type-helpers` - Advanced TypeScript type utilities and helpers
10+
- `@zayne-labs/toolkit-react` - React-specific hooks, utilities, and Zustand integrations
11+
12+
## ✨ Features
13+
14+
- 🎯 Modular design - Import only what you need
15+
- 📝 Full TypeScript support with advanced type utilities
16+
- ⚛️ React hooks and utilities for common patterns
17+
- 🔄 Zustand store integrations and helpers
18+
- 🎨 Zero runtime overhead for type utilities
19+
- 📦 Tree-shakeable exports
20+
- 🧪 Thoroughly tested utilities
21+
- 🔜 Support for Vue, Svelte, and Solid coming soon!
22+
23+
## 📥 Installation
24+
25+
```bash
26+
# Using pnpm (recommended)
27+
pnpm add @zayne-labs/toolkit
28+
29+
# Using npm
30+
npm install @zayne-labs/toolkit
31+
32+
# Using yarn
33+
yarn add @zayne-labs/toolkit
34+
```
35+
36+
## 🚀 Quick Start
37+
38+
```typescript
39+
// Core utilities
40+
import { someUtil } from '@zayne-labs/toolkit/core'
41+
42+
// React hooks
43+
import { useToggle } from '@zayne-labs/toolkit/react'
44+
45+
// React utilities
46+
import { cn } from '@zayne-labs/toolkit/react/utils'
47+
48+
// Zustand utilities
49+
import { createStore } from '@zayne-labs/toolkit/react/zustand'
50+
51+
// Type helpers
52+
import type { Prettify } from '@zayne-labs/toolkit/type-helpers'
53+
```
54+
55+
## 🛠️ Development
56+
57+
This project uses pnpm as the package manager. To get started with development:
58+
59+
```bash
60+
# Install dependencies
61+
pnpm install
62+
63+
# Build all packages
64+
pnpm build
65+
66+
# Run development build
67+
pnpm build:dev
68+
69+
# Run tests
70+
pnpm build:test
71+
72+
# Lint code
73+
pnpm lint:eslint
74+
75+
# Format code
76+
pnpm lint:format
77+
```
78+
79+
## 📁 Project Structure
80+
81+
```
82+
toolkit/
83+
├── packages/
84+
│ ├── toolkit/ # Main package that exports all utilities
85+
│ ├── toolkit-core/ # Core JavaScript/TypeScript utilities
86+
│ ├── toolkit-react/ # React-specific hooks and utilities
87+
│ └── toolkit-type-helpers/ # TypeScript type utilities
88+
├── dev/ # Development utilities
89+
└── package.json # Root package.json
90+
```
91+
92+
## 🤝 Contributing
93+
94+
We welcome contributions! Please check out our [contribution guidelines](https://github.com/zayne-labs/contribute) for details on how to get started.
95+
96+
## 📄 License
97+
98+
MIT © [Ryan Zayne]
99+
100+
---

0 commit comments

Comments
 (0)