Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds note on shims for older platforms (#155) #161

Merged
merged 1 commit into from
Oct 15, 2017
Merged

Adds note on shims for older platforms (#155) #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,13 @@ Folktale can be installed through [npm][]:

## Supported platforms

Folktale is written for ECMAScript 2015 platforms, but it uses a subset of features that can
be safely backported to platforms as old as ECMAScript 3. If you're running your program in
an older platform, you'll need [es5-shim][] and [es6-shim][].

[es5-shim]: https://github.com/es-shims/es5-shim
[es6-shim]: https://github.com/es-shims/es6-shim

- Node 4.x, Node 6+ ([**Node 5.x is not supported**](https://github.com/origamitower/folktale/issues/47))


Expand Down
10 changes: 10 additions & 0 deletions docs/_docs/v2.0.0/download.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@ folktale.core.lambda.identity(1); // ==> 1
Browsers don't have native support for CommonJS modules. We still recommend using a module system (like [Browserify][] or [WebPack][]) and bundling your modules to distribute your application. This allows you to only load the parts of Folktale that you use, reducing the amount of data you have to send to your users.


### Pre-requisites for ES3 and ES5 browsers

Folktale is written for ECMAScript 2015 platforms, but it uses a subset of features that can
be safely backported to platforms as old as ECMAScript 3. If you're running your program in
an older platform, you'll need [es6-shim][], and you might need [es5-shim][].

[es5-shim]: https://github.com/es-shims/es5-shim
[es6-shim]: https://github.com/es-shims/es6-shim


### Using Browserify

First install Browserify from npm (you should have a package.json describing your application's dependencies):
Expand Down