📝 Add 'installation' and 'usage' and example

Signed-off-by: kei-g <km.8k6ce+github@gmail.com>

Author: kei-g

.npmignore

@@ -6,6 +6,7 @@
 **/.travis.yml
 **/CODE_OF_CONDUCT.md
 **/build/
+**/example.ts
 **/src/
 **/test/
 **/tsconfig.json

README.md

@@ -2,7 +2,63 @@
 
 [![coverage][nyc-cov-image]][github-url] [![maintenance][maintenance-image]][npmsio-url] [![quality][quality-image]][npmsio-url]
 
-Async Iterable Queue
+`async-iterable-queue` - A library for 'Queue' class which implements AsyncIterable\<T\> works on [Node.js](https://nodejs.org/)
+
+## Installation
+
+```shell
+npm i async-iterable-queue
+```
+
+## Usage
+
+```typescript
+import { AsyncIterableQueue } from 'async-iterable-queue'
+
+type Foo = {
+  id: number
+  name: string
+}
+
+async function example1(queue: AsyncIterableQueue<Foo>): Promise<void> {
+  console.debug('pushing 123')
+  await queue.push({
+    id: 123,
+    name: 'foo',
+  })
+  console.debug('123 has been pushed')
+  await queue.push({
+    id: 456,
+    name: 'bar',
+  })
+  console.debug('456 has been pushed')
+  await queue.push({
+    id: 789,
+    name: 'baz',
+  })
+  console.debug('789 has been pushed')
+  await queue.end()
+  console.debug('\'end\' has been pushed')
+}
+
+async function example2(queue: AsyncIterableQueue<Foo>): Promise<void> {
+  for await (const value of queue)
+    console.debug(value)
+  console.debug('all elements have been popped from queue')
+}
+
+async function example(): Promise<void> {
+  console.debug('example for AsyncIterableQueue has begun')
+  const queue = new AsyncIterableQueue<Foo>()
+  await Promise.all([
+    example1(queue),
+    example2(queue),
+  ])
+  console.debug('example for AsyncIterableQueue has finished')
+}
+
+example()
+```
 
 [depencency-image]:https://img.shields.io/librariesio/release/npm/async-iterable-queue?logo=nodedotjs
 [dependency-url]:https://npmjs.com/package/async-iterable-queue?activeTab=dependencies

example.ts

@@ -0,0 +1,46 @@
+
+import { AsyncIterableQueue } from './src'
+
+type Foo = {
+  id: number
+  name: string
+}
+
+async function example1(queue: AsyncIterableQueue<Foo>): Promise<void> {
+  console.debug('pushing 123')
+  await queue.push({
+    id: 123,
+    name: 'foo',
+  })
+  console.debug('123 has been pushed')
+  await queue.push({
+    id: 456,
+    name: 'bar',
+  })
+  console.debug('456 has been pushed')
+  await queue.push({
+    id: 789,
+    name: 'baz',
+  })
+  console.debug('789 has been pushed')
+  await queue.end()
+  console.debug('\'end\' has been pushed')
+}
+
+async function example2(queue: AsyncIterableQueue<Foo>): Promise<void> {
+  for await (const value of queue)
+    console.debug(value)
+  console.debug('all elements have been popped from queue')
+}
+
+async function example(): Promise<void> {
+  console.debug('example for AsyncIterableQueue has begun')
+  const queue = new AsyncIterableQueue<Foo>()
+  await Promise.all([
+    example1(queue),
+    example2(queue),
+  ])
+  console.debug('example for AsyncIterableQueue has finished')
+}
+
+example()