version 1

README.md

@@ -1,3 +1,14 @@
 # read-text-file
 
-NOTE: es5 version requires babel-polyfill
+handles and strips byte order marks when reading a text file
+
+```bash
+npm install read-text-file --save
+```
+
+```javascript
+var readTextFile = require('read-text-file');
+
+var contentsPromise = readTextFile.read('path/to/file.txt');
+var contents = readTextFile.readSync('path/to/file.txt');
+```

build/read-text-file.d.ts

@@ -1,2 +1,2 @@
-export declare function readTextFile(path: string): Promise<string>;
-export declare function readTextFileSync(path: string): string;
+export declare function read(path: string): Promise<string>;
+export declare function readSync(path: string): string;

package.json

@@ -1,11 +1,12 @@
 {
   "name": "read-text-file",
-  "version": "0.0.0-alpha.3",
-  "description": "handles and strips byte order marks when reading a text file",
+  "version": "1.0.0",
   "keywords": [
     "textfile",
     "text",
-    "file"
+    "file",
+    "bom",
+    "byte order mark"
   ],
   "author": "matgr1",
   "license": "MIT",

src/read-text-file.ts

@@ -3,7 +3,7 @@ import * as path from "path";
 
 import { StringDecoder } from "string_decoder";
 
-export async function readTextFile(path: string): Promise<string>
+export async function read(path: string): Promise<string>
 {
 	let stat = await fileStat(path);
 
@@ -40,7 +40,7 @@ export async function readTextFile(path: string): Promise<string>
 	return result;
 }
 
-export function readTextFileSync(path: string): string
+export function readSync(path: string): string
 {
 	let stat = fs.statSync(path);