docs: separator docs

TimMikeladze · Aug 10, 2023 · 44c8372 · 44c8372
1 parent a413897
commit 44c8372
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -26,13 +26,15 @@ pnpm add space-slug
 ## 🚀 Getting Started
 
 ```ts
-const { spaceSlug, color, digits } from 'space-slug';
+const { spaceSlug, color, digits, noun } from 'space-slug';
 
 const slug = spaceSlug();
 // Returns: serenity-2391
 
-const slug = spaceSlug([color(), digits(2)]);
-// Returns: blue-80
+const slug = spaceSlug([color(), noun(2), digits(3)], {
+  separator: '_'
+});
+// Returns: blue_celestial_labyrinth_718
 ```
 
 ## 📚 Custom dictionaries and locales