Skip to content

Commit

Permalink
Updated 'README.md' to more prominently feature a link to the home pa…
Browse files Browse the repository at this point in the history
…ge, plus a link to the introductory blog post.
  • Loading branch information
dchambers committed Oct 6, 2014
1 parent 698ac8c commit abac918
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,22 @@

# IterizerJs

Expressive & concise code using ES6 iterables:

* [Home Page](http://dchambers.github.io/iterizerjs/)
* [Introductory Blog](http://dchambers.github.io/on-the-discovery-of-iterizerjs/)


## Introduction

IterizerJs makes it easier to write code that makes extensive use of ES6 iterables. It is not a polyfill, but merely makes it easier to get the most out of ES6 iterables and generators. It provides:

* A `range()` function so you never need to use the classic `for` loop again — `for...of` and `for...in` can be used instead.
* Implementations of the ES5 array methods (`map()`, `filter()`, `every()`, `some()`, `reduce()`, `reduceRight()`, `indexOf()` & `lastIndexOf()`) for use with any iterable.
* `limit()`, `nthItem()` and `first()` methods to reduce the number of items returned by long-running and infinite iterables.
* Other helpful methods like `join()`, `toArray()`, `sum()` & `product()`.

By making extensive use of ES6 iterators, ES6 generators & the ES5 array methods, you can write more _concise_ and more _re-usable_ code — see the [home-page](http://dchambers.github.io/iterizerjs/) for more details.
By making extensive use of ES6 iterators, ES6 generators & the ES5 array methods, you can write more _concise_ and more _re-usable_ code — see the [home page](http://dchambers.github.io/iterizerjs/) for more details.

You can run ES6 generators and iterators natively on the following platforms:

Expand All @@ -18,7 +26,7 @@ You can run ES6 generators and iterators natively on the following platforms:
* Node.js 0.11.4 (the `--harmony` switch must be used)
* Older Browsers (by using [regenerator](https://facebook.github.io/regenerator/) to convert your code to ES5 you can run your code in most browsers)

Take a look at the [home-page](http://dchambers.github.io/iterizerjs/) for a more detailed explanation of why you might want to use IterizerJs.
Take a look at the [home page](http://dchambers.github.io/iterizerjs/) for a more detailed explanation of why you might want to use IterizerJs.


## Installing
Expand Down

0 comments on commit abac918

Please sign in to comment.