Skip to content

Commit 5df311c

Browse files
committed
style: follow CLAUDE.md emoji guidelines in README
- Remove excessive emojis from section headers - Keep only allowed emojis (πŸ“¦, πŸ’‘) used sparingly - Remove emojis from "What's Inside" tree - Maintain visual structure with ASCII arrows (β†’) - Follow minimal emoji philosophy from CLAUDE.md
1 parent 205d887 commit 5df311c

1 file changed

Lines changed: 22 additions & 22 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
**Core infrastructure library for Socket.dev security tools** β€” utilities, constants, and helpers with zero dependencies.
88

9-
## 🎯 Quick Start
9+
## Quick Start
1010

1111
```bash
1212
pnpm add @socketsecurity/lib
@@ -28,19 +28,19 @@ spinner.stop()
2828

2929
```
3030
@socketsecurity/lib
31-
β”œβ”€β”€ 🎨 Visual Effects ← Spinners, shimmer, themes, logger
32-
β”œβ”€β”€ πŸ“ File System ← fs, paths, globs, temp files
33-
β”œβ”€β”€ πŸ“¦ Package Management ← npm, pnpm, yarn utilities
34-
β”œβ”€β”€ πŸ”§ Process & Spawn ← Safe process spawning, IPC
35-
β”œβ”€β”€ 🌍 Environment ← 68 typed env getters (CI, paths, etc)
36-
β”œβ”€β”€ 🎯 Constants ← Node.js, npm, platform constants
37-
β”œβ”€β”€ 🧩 Utilities ← Arrays, objects, strings, promises
38-
└── πŸ“ Types ← Full TypeScript definitions
31+
β”œβ”€β”€ Visual Effects β†’ Spinners, shimmer, themes, logger
32+
β”œβ”€β”€ File System β†’ fs, paths, globs, temp files
33+
β”œβ”€β”€ Package Management β†’ npm, pnpm, yarn utilities
34+
β”œβ”€β”€ Process & Spawn β†’ Safe process spawning, IPC
35+
β”œβ”€β”€ Environment β†’ 68 typed env getters (CI, paths, etc)
36+
β”œβ”€β”€ Constants β†’ Node.js, npm, platform constants
37+
β”œβ”€β”€ Utilities β†’ Arrays, objects, strings, promises
38+
└── Types β†’ Full TypeScript definitions
3939
```
4040

4141
## πŸ’‘ Key Features
4242

43-
### 🎨 Visual Effects
43+
### Visual Effects
4444

4545
**Themed spinners and text effects:**
4646

@@ -57,7 +57,7 @@ spinner.start()
5757

5858
πŸ‘‰ [**Theme System Docs**](./docs/themes.md)
5959

60-
### πŸ“ File System
60+
### File System
6161

6262
**Safe, typed file operations:**
6363

@@ -68,7 +68,7 @@ const pkg = await readJsonFile<PackageJson>('./package.json')
6868
await writeJsonFile('./output.json', { data: pkg })
6969
```
7070

71-
### πŸ“¦ Package Management
71+
### Package Management
7272

7373
**Parse and validate package specs:**
7474

@@ -79,7 +79,7 @@ const spec = parsePackageSpec('lodash@^4.17.0')
7979
// { name: 'lodash', version: '^4.17.0', type: 'range', ... }
8080
```
8181

82-
### 🌍 Environment Variables
82+
### Environment Variables
8383

8484
**68 typed environment getters:**
8585

@@ -93,7 +93,7 @@ if (getCI()) {
9393
}
9494
```
9595

96-
### 🎯 Constants
96+
### Constants
9797

9898
**Access platform and Node.js constants:**
9999

@@ -107,7 +107,7 @@ import {
107107
import { DARWIN, WIN32 } from '@socketsecurity/lib/constants/platform'
108108
```
109109

110-
## πŸ“š Common Patterns
110+
## Common Patterns
111111

112112
### Spinner with Progress
113113

@@ -156,7 +156,7 @@ const result = await timeout(fetchData(), 5000)
156156
const data = await retry(() => fetchData(), { maxAttempts: 3 })
157157
```
158158

159-
## πŸ—‚οΈ Module Organization
159+
## Module Organization
160160

161161
**120+ granular exports** organized by category:
162162

@@ -198,7 +198,7 @@ const data = await retry(() => fetchData(), { maxAttempts: 3 })
198198
└─ utils β†’ Color resolution, theme creation
199199
```
200200

201-
## πŸŽ“ Documentation
201+
## Documentation
202202

203203
| Doc | Description |
204204
|-----|-------------|
@@ -207,7 +207,7 @@ const data = await retry(() => fetchData(), { maxAttempts: 3 })
207207
| [**Build Architecture**](./docs/build.md) | Vendored dependencies, build system |
208208
| [**CLAUDE.md**](./CLAUDE.md) | Coding standards and patterns |
209209

210-
## πŸ—οΈ Architecture
210+
## Architecture
211211

212212
```
213213
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
@@ -230,7 +230,7 @@ const data = await retry(() => fetchData(), { maxAttempts: 3 })
230230
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
231231
```
232232

233-
## πŸ› οΈ Development
233+
## Development
234234

235235
```bash
236236
# Setup
@@ -252,7 +252,7 @@ pnpm run lint # Lint code
252252
pnpm run fix # Auto-fix issues
253253
```
254254

255-
## πŸ“Š Stats
255+
## Stats
256256

257257
- **183** TypeScript modules
258258
- **120+** granular exports
@@ -261,15 +261,15 @@ pnpm run fix # Auto-fix issues
261261
- **4600+** tests passing
262262
- **Zero** runtime dependencies
263263

264-
## 🀝 Contributing
264+
## Contributing
265265

266266
See [CLAUDE.md](./CLAUDE.md) for:
267267
- Code style and patterns
268268
- Path alias usage
269269
- Testing guidelines
270270
- Build system details
271271

272-
## πŸ“„ License
272+
## License
273273

274274
MIT
275275

0 commit comments

Comments
Β (0)