Write Readme

README.md

@@ -1,3 +1,107 @@
 # Humanizer.ts
 
 Humanizer meets all your TypeScript needs for manipulating and displaying strings, dates, times, timespans, numbers and quantities.
+
+## Implemented
+
+- ByteSize
+- Ordinalize
+- ToQuantity
+- Vocabularies
+- ...In Progress
+
+## Usage
+
+Import the Extensions:
+
+```ts
+import "https://raw.githubusercontent.com/fakoua/Humanizer.ts/master/src/Humanizer/Extensions/ByteSize.ts"
+import "https://raw.githubusercontent.com/fakoua/Humanizer.ts/master/src/Humanizer/Extensions/Ordinalize.ts"
+import "https://raw.githubusercontent.com/fakoua/Humanizer.ts/master/src/Humanizer/Extensions/ToQuantity.ts"
+import "https://raw.githubusercontent.com/fakoua/Humanizer.ts/master/src/Humanizer/Extensions/Vocabularies.ts"
+```
+
+## Examples
+
+```ts
+//Your imports here
+
+let result = (10).megabytes().toString()
+console.log(result) // -> 10 MB
+```
+
+## ByteSize
+
+Humanizer includes a port of the brilliant [ByteSize](https://github.com/omar/ByteSize) library.
+Quite a few changes and additions are made on `ByteSize` to make the interaction with `ByteSize` easier and more consistent with the Humanizer API.
+Here is a few examples of how you can convert from numbers to byte sizes and between size magnitudes:
+
+```ts
+let fileSize = (10).kilobytes()
+console.log(fileSize.bits)          // -> 81920
+console.log(fileSize.bytes)         // -> 10240
+console.log(fileSize.kilobytes)     // -> 10
+console.log(fileSize.megabytes)     // -> 0.009765625
+console.log(fileSize.gigabytes)     // -> 0.0000095367431640625
+console.log(fileSize.terabytes)     // -> 9.313225746154785e-9
+```
+
+There are a few extension methods that allow you to turn a number into a ByteSize instance:
+
+```ts
+(3).bits();
+(5).bytes();
+(10.5).kilobytes();
+(2.5).megabytes();
+(10.2).gigabytes();
+(4.7).terabytes();
+```
+
+You can also add/subtract the values
+
+```ts
+let f = (4).gigabytes().add((22).megabytes()).subtract((980).kilobytes()).addGigabytes(1)
+console.log(f.toString()) // -> 5.020549774169922 GB
+```
+
+## Vocabularies
+
+### Pluralize
+
+`Pluralize` pluralizes the provided input while taking irregular and uncountable words into consideration:
+
+```ts
+"Man".pluralize()       // -> Men
+"string".pluralize()    // -> "strings"
+
+```
+
+### Singularize
+
+`Singularize` singularizes the provided input while taking irregular and uncountable words into consideration:
+
+```ts
+"Men".singularize()     //-> "Man"
+"strings".singularize() //-> "string"
+```
+
+## Ordinalize
+
+```ts
+(1).ordinalize() => "1st"
+(5).ordinalize() => "5th"
+```
+
+...
+
+## ToQuantity
+
+```ts
+"case".toQuantity(0) => "0 cases"
+"case".toQuantity(1) => "1 case"
+"case".toQuantity(5) => "5 cases"
+"man".toQuantity(0) => "0 men"
+"man".toQuantity(1) => "1 man"
+"man".toQuantity(2) => "2 men"
+```
+...

readme_examples.ts

@@ -0,0 +1,27 @@
+import "https://raw.githubusercontent.com/fakoua/Humanizer.ts/master/src/Humanizer/Extensions/ByteSize.ts"
+import "https://raw.githubusercontent.com/fakoua/Humanizer.ts/master/src/Humanizer/Extensions/Ordinalize.ts"
+import "https://raw.githubusercontent.com/fakoua/Humanizer.ts/master/src/Humanizer/Extensions/ToQuantity.ts"
+import "https://raw.githubusercontent.com/fakoua/Humanizer.ts/master/src/Humanizer/Extensions/Vocabularies.ts"
+
+let result = (10).megabytes().toString()
+console.log(result)
+
+let fileSize = (10).kilobytes()
+console.log(fileSize.bits)          // -> 81920
+console.log(fileSize.bytes)         // -> 10240
+console.log(fileSize.kilobytes)     // -> 10
+console.log(fileSize.megabytes)     // -> 0.009765625
+console.log(fileSize.gigabytes)     // -> 0.0000095367431640625
+console.log(fileSize.terabytes)     // -> 9.313225746154785e-9
+
+//(3).bits();
+//(5).bytes();
+//(10.5).kilobytes();
+//(2.5).megabytes();
+//(10.2).gigabytes();
+//(4.7).terabytes();
+
+let f = (4).gigabytes().add((22).megabytes()).subtract((980).kilobytes()).addGigabytes(1)
+console.log(f.toString()) // -> 5.020549774169922 GB
+
+"Man".pluralize() // -> Men