Added all files: the first true commit.

davidemiceli · Aug 4, 2016 · 2b91cee · 2b91cee
1 parent 885dc36
commit 2b91cee
Show file tree

Hide file tree

Showing 7 changed files with 77,753 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,25 @@
-# gender-detection
-Determine a person's gender based on his/her first name.
+# Gender Detection
+
+## Description
+A node.js module to determine a person's gender based on his/her first name.
+It works also for many languages other than english.
+
+## Example
+```javascript
+// Require gender detection module
+var gender = require('gender-detection');
+
+// Use it to detect the gender:
+g = gender.detect('Tim Johnson');
+// "male"
+
+g = gender.detect('Holly');
+// "female"
+
+g = gender.detect('GhJGhgj')
+// "unknown"
+```
+
+## Installation
+
+    $ npm install git+https://[email protected]/davidemiceli/gender-detection.git