diff --git a/README.md b/README.md index aa33b48..ea3ad46 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# Gender detection from name -This simple project detects the gender of a first name. An optional language parameter can be specified to improve the detection, for example: Andrea in EN is female, in IT is male. If no language is specified, EN has priority. +# Gender detection from name [![Donate](https://img.shields.io/badge/paypal-donate-179BD7.svg)](https://www.paypal.me/dviolante) +Library to detect the gender of a first name. An optional language parameter can be specified to improve the detection, for example: Andrea in EN is female, in IT is male. If no language is specified, EN has priority. ### Install `npm i gender-detection-from-name` @@ -8,14 +8,12 @@ This simple project detects the gender of a first name. An optional language par ```js const { getGender } = require('gender-detection-from-name') -function main() { - const genderEN = getGender('Andrea', 'en') - const genderIT = getGender('Andrea', 'it') - const gender = getGender('Jennifer') - console.log(genderEN) // female - console.log(genderIT) // male - console.log(gender) // female -} +const genderEN = getGender('Andrea', 'en') +const genderIT = getGender('Andrea', 'it') +const gender = getGender('Jennifer') +console.log(genderEN) // female +console.log(genderIT) // male +console.log(gender) // female ``` ### Run tests @@ -23,3 +21,6 @@ function main() { ### Run lint - `npm run lint` + +### Author +- [Davide Violante](https://github.com/DavideViolante/) diff --git a/package-lock.json b/package-lock.json index a3e803f..c4df71a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "gender-detection-from-name", - "version": "1.4.1", + "version": "1.5.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index f32241b..101645f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "gender-detection-from-name", - "version": "1.4.1", + "version": "1.5.0", "description": "Gender detection from first name", "main": "index.js", "scripts": {