Skip to content

Commit 2123092

Browse files
committed
chore: wip
1 parent 0b999f8 commit 2123092

File tree

1 file changed

+45
-42
lines changed

1 file changed

+45
-42
lines changed

README.md

Lines changed: 45 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -14,51 +14,51 @@ A performance-focused and lightweight faker library for TypeScript with comprehe
1414

1515
- ⚡️ **Performance-focused** - Built with speed and efficiency in mind
1616
- 🌍 **Multi-locale Support** - Complete translations for 26 languages:
17-
- Afrikaans (af)
18-
- Arabic (ar)
19-
- Azerbaijani (az)
20-
- Czech (cs)
21-
- Danish (da)
22-
- German (de)
23-
- English (en)
24-
- Esperanto (eo)
25-
- Spanish (es)
26-
- Persian/Farsi (fa)
27-
- Finnish (fi)
28-
- French (fr)
29-
- Hebrew (he)
30-
- Hindi (hi)
31-
- Italian (it)
32-
- Japanese (ja)
33-
- Korean (ko)
34-
- Dutch (nl)
35-
- Norwegian (no)
36-
- Polish (pl)
37-
- Portuguese (pt)
38-
- Swedish (sv)
39-
- Filipino (tl)
40-
- Turkish (tr)
41-
- Ukrainian (uk)
42-
- Chinese (zh)
17+
- Afrikaans _(af)_
18+
- Arabic _(ar)_
19+
- Azerbaijani _(az)_
20+
- Czech _(cs)_
21+
- Danish _(da)_
22+
- German _(de)_
23+
- English _(en)_
24+
- Esperanto _(eo)_
25+
- Spanish _(es)_
26+
- Persian/Farsi _(fa)_
27+
- Finnish _(fi)_
28+
- French _(fr)_
29+
- Hebrew _(he)_
30+
- Hindi _(hi)_
31+
- Italian _(it)_
32+
- Japanese _(ja)_
33+
- Korean _(ko)_
34+
- Dutch _(nl)_
35+
- Norwegian _(no)_
36+
- Polish _(pl)_
37+
- Portuguese _(pt)_
38+
- Swedish _(sv)_
39+
- Filipino _(tl)_
40+
- Turkish _(tr)_
41+
- Ukrainian _(uk)_
42+
- Chinese _(zh)_
4343
- 📦 **Lightweight** - Minimal dependencies and small bundle size
4444
- 💪 **Fully Typed** - Written in TypeScript with comprehensive type definitions
4545
- 🎯 **Comprehensive Data** - 16+ data categories including:
46-
- Person (names, job titles, genders)
47-
- Address (streets, cities, countries)
48-
- Company (names, industries, buzzwords)
49-
- Internet (emails, domains)
50-
- Phone numbers
51-
- Food (dishes, ingredients, cuisines)
52-
- Animals (dogs, cats, birds, fish, etc.)
53-
- Sports (teams, athletes)
54-
- Music (genres, artists, songs)
55-
- Commerce (products, colors, materials)
56-
- Books (titles, authors, publishers)
57-
- Vehicles (manufacturers, models, types)
58-
- Words (adjectives, verbs, nouns, etc.)
59-
- Hacker/Tech (abbreviations, phrases)
60-
- System (file names, file types)
61-
- Science (elements, units, constants)
46+
- Person _(names, job titles, genders)_
47+
- Address _(streets, cities, countries)_
48+
- Company _(names, industries, buzzwords)_
49+
- Internet _(emails, domains)_
50+
- Phone numbers _(numbers)_
51+
- Food _(dishes, ingredients, cuisines)_
52+
- Animals _(dogs, cats, birds, fish, etc.)_
53+
- Sports _(teams, athletes)_
54+
- Music _(genres, artists, songs)_
55+
- Commerce _(products, colors, materials)_
56+
- Books _(titles, authors, publishers)_
57+
- Vehicles _(manufacturers, models, types)_
58+
- Words _(adjectives, verbs, nouns, etc.)_
59+
- Hacker/Tech _(abbreviations, phrases)_
60+
- System _(file names, file types)_
61+
- Science _(elements, units, constants)_
6262

6363
## Installation
6464

@@ -338,6 +338,7 @@ See the [CLI documentation](https://nanofaker.stacksjs.org/cli) for complete det
338338
nanofaker is designed for performance and efficiency:
339339

340340
**Performance:**
341+
341342
-**9 out of 9 benchmarks won** (100% win rate!)
342343
-**9.28x faster than @faker-js/faker** on average
343344
- 🚀 **34.04M ops/s** for country generation
@@ -346,6 +347,7 @@ nanofaker is designed for performance and efficiency:
346347
- 📊 **6.90ms** to generate 10,000 complex user objects
347348

348349
**Package Size:**
350+
349351
- 📦 **174 KB** published (core package only)
350352
- 🎯 **24.7x smaller than @faker-js/faker** (4.29 MB)
351353
- 🪶 **38 files** vs 231 in @faker-js/faker
@@ -375,6 +377,7 @@ bun run bench
375377
```
376378

377379
**Detailed Documentation:**
380+
378381
- 📊 [BENCHMARKS.md](./BENCHMARKS.md) - Complete performance results and methodology
379382

380383
## Testing

0 commit comments

Comments
 (0)