📝 create new README docs

Author: VitorLuizC

README.md

@@ -5,7 +5,7 @@
 [![Library minified size](https://badgen.net/bundlephobia/min/normalize-text)](https://bundlephobia.com/result?p=normalize-text)
 [![Library minified + gzipped size](https://badgen.net/bundlephobia/minzip/normalize-text)](https://bundlephobia.com/result?p=normalize-text)
 
-Provides a simple API to normalize texts, white-spaces, paragraphs & diacritics.
+Provides a simple API to normalize texts, white-spaces, names, paragraphs & diacritics (accents).
 
 ## Install
 
@@ -18,90 +18,116 @@ npm install normalize-text --save
 yarn add normalize-text
 ```
 
+### Install from CDN
+
+The bundles of this module are also available on JSDelivr and UNPKG CDNs.
+
+In both you can import just the bundle you want or use default one, UMD.
+
+```html
+<!-- Using default bundle from JSDelivr -->
+<script src="https://cdn.jsdelivr.net/npm/normalize-text"></script>
+
+<!-- Using default bundle from UNPKG -->
+<script src="https://unpkg.com/normalize-text"></script>
+
+<script>
+  /**
+   * UMD bundle expose brazilian-values through `normalizeText` object.
+   */
+  normalizeText.capitalizeFirstLetter('vitor');
+  //=> "Vitor"
+</script>
+```
+
 ## Usage
 
+All the functions are named exported from module.
+
 ```js
-import normalize from 'normalize-text';
+import { normalizeText } from 'normalize-text';
 
-const input = document.querySelector('input[name="name"]');
-const name = normalize(input.value);
+normalizeText([
+  'Olá\r\n',
+  '  como  está a   senhorita?'
+]);
+//=> "ola como esta a senhorita?"
 ```
 
 ## API
 
-### `normalize`
+### `capitalizeFirstLetter`
 
-Join arguments (when receives an `Array`), normalize it's whitespaces, normalize it's diacritics and transform to lower case.
+Capitalize first character of received text.
 
 ```js
-normalize(['     Olá, \r\n', 'Fernanda \t MONtenegro']);
-// => 'ola, fernanda montenegro'
+capitalizeFirstLetter('vitorLuizC');
+//=> "VitorLuizC"
 ```
 
-#### Type definition
-
-```ts
-export default function normalize(values: string | string[]): string;
-```
+### `normalizeDiacritics`
 
-### `normalizeWhitespaces`
+If `String.prototype.normalize` is supported it normalizes diacritics by replacing them with "clean" character from received text.
 
-Remove spaces from start and end, transform multiple spaces into single one and every space character into whitespace character.
+> It doesn't normalize special characters.
 
 ```js
-normalizeWhitespaces('  Fernanda \t Montenegro\r\n');
-// => 'Fernanda Montenegro'
-```
+normalizeDiacritics('Olá, você aí');
+//=> 'Ola, voce ai'
 
-#### Type definition
+normalizeDiacritics('àáãâäéèêëíìîïóòõôöúùûüñçÀÁÃÂÄÉÈÊËÍÌÎÏÓÒÕÔÖÚÙÛÜÑÇ');
+//=> "aaaaaeeeeiiiiooooouuuuncAAAAAEEEEIIIIOOOOOUUUUNC"
 
-```ts
-export function normalizeWhitespaces(value: string): string;
+normalizeDiacritics('@_$><=-#!,.`\'"')
+//=> "@_$><=-#!,.`'\"";
 ```
 
-### `normalizeDiacritics`
+### `normalizeName`
 
-Normalize diacritics removing diacritics (accents) from letters.
+Normalize received name by normalizing it's white-spaces and capitalizing first letter of every word but exceptions (received in lower-case).
 
 ```js
-normalizeDiacritics('Olá, você aí!');
-// => 'Ola, voce ai!'
-```
+normalizeName(' fernanDA  MONTENEGRO');
+//=> "Fernanda Montenegro"
 
-#### Type definition
-
-```ts
-export function normalizeDiacritics(value: string): string;
+normalizeName(' wilson da costa', ['da']);
+//=> "Wilson da Costa"
 ```
 
 ### `normalizeParagraph`
 
-Normalize a paragraph. Normalize it's whitespaces, transform first letter to upper case and put a dot at end.
+Normalize a paragraph by normalizing its white-spaces, capitalizing first letter and adding a period at end.
 
 ```js
+normalizeParagraph(' once upon a time');
+//=> "Once upon a time."
+
 normalizeParagraph('hello world, my friend\r\n');
 // => 'Hello world, my friend.'
 ```
 
-#### Type definition
+### `normalizeText`
+
+Resolve received texts (when receives an `Array`) by normalizing its white-spaces and its diacritics and transforming to lower-case.
 
-```ts
-export function normalizeParagraph(value: string): string;
+```js
+normalizeText(' so there\'s  a  Way to NORMALIZE ');
+//=> "so there\'s a way to normalize"
+
+normalizeText(['Olá\r\n', 'como está a   senhorita?']);
+//=> "ola como esta a senhorita?"
 ```
 
-### `normalizeName`
+### `normalizeWhiteSpaces`
 
-Normalize a name. Normalize it's whitespaces and capitalize letters.
+Normalize all white-space characters and remove trailing ones received text.
 
 ```js
-normalizeName(' fernanda \tMONTENEGRO');
-// => 'Fernanda Montenegro'
-```
-
-#### Type definition
+normalizeWhiteSpaces(' What exactly is it?   ');
+//=> "What exactly is it?"
 
-```ts
-export function normalizeName(value: string): string;
+normalizeWhiteSpaces('Hi,   how is \r\n everything  \t?');
+//=> 'Hi, how is everything ?'
 ```
 
 ## License