Moving to typescript (#1)

Moving to typescript

index.d.ts

@@ -0,0 +1,26 @@
+/**
+Get to know how long it will take to read a paragraph, text or easy acording 
+to a [Medium's article](https://help.medium.com/hc/en-us/articles/214991667-Read-time). 
+Read time is based on the average reading speed of an adult (roughly 265 WPM). 
+
+@param input - The input to analize how long it will take to read.
+@param textOrWpm - Alternative text you want to introduce, otherwise the reading speed (wpm).
+@param wpm - Reading speed, word per minutes (wpm).
+
+Default: `265`.
+
+@example
+```
+import m2r from 'minutes-to-read';
+
+m2r('Lorem ipsum');
+// => less than a min to read
+```
+*/
+declare function m2r(
+  input: string,
+  textOrWpm?: number | string,
+  wpm?: number,
+): string;
+
+export = m2r;

index.test-d.ts

@@ -0,0 +1,7 @@
+import {expectType} from 'tsd';
+import m2r = require('.');
+
+expectType<string>(m2r('Lorem ipsum'));
+expectType<string>(m2r('Lorem ipsum', 1));
+expectType<string>(m2r('Lorem ipsum', 'minutes to read'));
+expectType<string>(m2r('Lorem ipsum', 'minutes to read', 1));

package.json

@@ -1,21 +1,22 @@
 {
   "name": "minutes-to-read",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Minutes to read",
   "main": "index.js",
   "scripts": {
-    "test": "ava & xo"
+    "test": "ava & xo && tsd"
   },
   "repository": "abranhe/minutes-to-read",
   "author": {
     "name": "Abraham Hernandez",
     "email": "abraham@abranhe.com",
     "url": "https://abranhe.com"
   },
-  "files": [ 
-    "index.js"
+  "files": [
+    "index.js",
+		"index.d.ts"
   ],
-  "keywords": [ 
+  "keywords": [
     "medium",
     "read",
     "words",
@@ -31,7 +32,8 @@
   "homepage": "https://p.abranhe.com/minutes-to-read",
   "devDependencies": {
     "ava": "^1.4.1",
-    "xo": "^0.24.0"
+    "xo": "^0.24.0",
+    "tsd": "^0.7.2"
   },
   "xo": {
     "ignores": [

readme.md

@@ -34,8 +34,8 @@ const longText = 'Lorem ipsum dolor sit am...' // 500 words
 m2r(longText, 'minutes to finish');
 // => 2 minutes to finish
 
-m2r(longText, 'minutes to read if you reading rate is 2 wpm', 2);
-// => 250 minutes to read if you reading rate is 2 wpm
+m2r(longText, 'minutes to read if your reading rate is 2 wpm', 2);
+// => 250 minutes to read if your reading rate is 2 wpm
 ```
 
 ## API