From 2209c0ea7670d035aa25144d0bc68131d23ec7e0 Mon Sep 17 00:00:00 2001 From: David Braun Date: Mon, 23 Oct 2017 11:46:08 -0400 Subject: [PATCH] README & API.md: minor edits --- README.md | 4 ++-- doc/API.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 435b51f..ea1d9b1 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,10 @@ already know most of how to use a `Channel`. Go's use of channels for concurrency is amazing and with JavaScript's async/await feature we have the basis for it as well. All that's missing is a solid `Channel` type. There are existing libraries but I wanted an idiomatic -`Channel` type that's more simple and minimally-opinionated. +`Channel` type that's simple and minimally-opinionated. This document assumes you're familiar with Go's channels and why you'd want to -use them. For explanatory background, read my [blog +use them. For explanatory background, see my [blog article](https://www.nodeguy.com/channels-for-javascript/) on the subject. ## Requirements diff --git a/doc/API.md b/doc/API.md index cf31601..e38c440 100644 --- a/doc/API.md +++ b/doc/API.md @@ -152,7 +152,7 @@ These properties are similar to the equivalently named properties of `Array`. ## Channel -### Channel([bufferLength = 0]) -> Channel +### Channel([bufferLength]) -> Channel Create a new `Channel` with an optional buffer. This allows an async function to push up to `bufferLength` values before blocking.