Skip to content

Commit 93b45d3

Browse files
chore: improve the description in readme
1 parent 503508f commit 93b45d3

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# name-generator
2-
This is a very simple project that creates words randomly. Which can be useful for not wasting time with finding a name for a new project.
1+
# NameGen
2+
3+
Effortlessly generate random names for your projects in a snap! Say goodbye to naming woes 🚀🌟
34

45
# Algorithm & Usage
56
The algorithm is very simple. It takes max, min length and starts with (optional) parameters. Then if you have specified starts with parameter, it will start with it or it will select a random letter to start with. Then we find out if this letter is a vowel or a consonant. If it is a vowel, we add a random consonant to the word. If it is a consonant, we add a random vowel to the word and that's it (for now).

0 commit comments

Comments
 (0)