Change package name to , add some docs

Author: basicdays

.idea/encodings.xml

@@ -0,0 +1 @@
+test/

.idea/modules.xml

@@ -0,0 +1,5 @@
+# History
+
+## 0.1.0
+
+- Info: Initial Release

.idea/node-stream-to-async-iterator.iml

@@ -1,4 +1,4 @@
-# hack to get osx to recognize a chane in PATH
+# hack to get osx to recognize a change in PATH
 SHELL := /usr/bin/env sh
 PATH := $(shell pwd)/node_modules/.bin:${PATH}
 
@@ -21,7 +21,7 @@ lib_asset_files := $(shell find lib -type f ! -name "*.js" ! -name "*.js.flow" !
 
 build_files := $(lib_files:lib/%=build/%)
 build_asset_files := $(lib_asset_files:lib/%=build/%)
-build_package_files := build/README.md build/package.json build/license
+build_package_files := build/README.md build/package.json build/license build/.npmignore
 
 
 # Build

.npmignore

@@ -1,15 +1,46 @@
 # Stream Async Iterator
 
+
+## Overview
+
+`stream-async-iterator` provides a wrapper that implements `Symbol.asyncIterator`. This will allow streams to be usable
+as async iterables that can be used in for-await-of loops.
+
 ## Installation
 
 ```
-$ npm install stream-async-iterator
+$ npm install stream-async-to-iterator
 ```
 
+The examples provides use async/await syntax for for-of loops. This assumes you are in an environment that natively
+supports this new syntax, or that you use a tool such as Babel. In addition, for async iterators to work properly,
+the `Symbol.asyncIterator` symbol must be defined. Core-js or `babel-polyfill` can both help with that.
 
-## Overview
 
-`stream-async-iterator` provides a wrapper that implements `Symbol.asyncIterator`.
+## Usage
+
+Import the StreamToAsyncIterator class and pass the stream to its constructor. The iterator instance can be directly
+used in for-of contexts.
+
+If the stream is in object mode, each iteration will produce the next object. See the
+[node documentation](https://nodejs.org/dist/latest-v6.x/docs/api/stream.html#stream_types_of_streams) for more
+information.
+
+```js
+#!/usr/bin/env node
+'use strict';
+require('core-js/es7/symbol');
+const fs = require('fs');
+const S2A = require('stream-to-async-iterator');
+
+
+(async function() {
+    const readStream = fs.createReadStream(__filename);
+    for await (const chunk of new S2A(readStream)) {
+        console.log(chunk);
+    }
+})();
+```
 
 
 ## References

History.md

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+'use strict';
+require('core-js/es7/symbol');
+const fs = require('fs');
+const S2A = require('..');
+
+
+(async function() {
+    const readStream = fs.createReadStream(__filename);
+    for await (const chunk of new S2A(readStream)) {
+        console.log(chunk);
+    }
+})();

Makefile

@@ -12,15 +12,15 @@ export const states = {
 };
 
 /**
- * @typedef {Object} StreamAsyncIterator~Options
+ * @typedef {Object} StreamAsyncToIterator~Options
  * @property {number} [size] - the size of each read from the stream for each iteration
  */
-type StreamAsyncIteratorOptions = {
+type StreamAsyncToIteratorOptions = {
     size?: number;
 }
 
 /**
- * @typedef {Object} StreamAsyncIterator~Iteration
+ * @typedef {Object} StreamAsyncToIterator~Iteration
  * @property {boolean} done
  * @property {*} value
  */
@@ -38,12 +38,12 @@ type Reject = (err: any) => void;
  * iteration. A size can be supplied to set an explicit call to `stream.read([size])` in
  * the options for each iteration.
  */
-export default class StreamAsyncIterator {
+export default class StreamAsyncToIterator {
     /**
      * @param {Readable} stream
-     * @param {StreamAsyncIterator~Options} [options]
+     * @param {StreamAsyncToIterator~Options} [options]
      */
-    constructor(stream: Readable, options: StreamAsyncIteratorOptions={}) {
+    constructor(stream: Readable, options: StreamAsyncToIteratorOptions={}) {
         /**
          * The underlying readable stream
          * @private
@@ -102,7 +102,7 @@ export default class StreamAsyncIterator {
 
     /**
      * Returns the next iteration of data. Rejects if the stream errored out.
-     * @returns {Promise<StreamAsyncIterator~Iteration>}
+     * @returns {Promise<StreamAsyncToIterator~Iteration>}
      */
     async next(): Promise<Iteration> {
         if (this._state === states.notReadable) {
@@ -164,7 +164,7 @@ export default class StreamAsyncIterator {
     }
 }
 
-Object.defineProperty(StreamAsyncIterator.prototype, (Symbol: any).asyncIterator, {
+Object.defineProperty(StreamAsyncToIterator.prototype, (Symbol: any).asyncIterator, {
     configurable: true,
     value: function() {return this;}
 });