| 1 | <h1>
|
| 2 | <img src="https://raw.github.com/cyclejs/cycle-core/master/logo.png" /> Cycle.js
|
| 3 | </h1>
|
| 4 |
|
| 5 | > Cycle.js is a fully reactive JavaScript framework for Human-Computer Interaction.
|
| 6 |
|
| 7 | Cycle *Core* is the minimum required tools you need for building applications. It is comprised of one single function, `Cycle.run(main, drivers)`.
|
| 8 |
|
| 9 | ## Installing
|
| 10 |
|
| 11 | [](http://badge.fury.io/js/%40cycle%2Fcore)
|
| 12 |
|
| 13 | `npm install rx @cycle/core`
|
| 14 |
|
| 15 | Note: `rx` is a **required** dependency. Without it, nothing will change.
|
| 16 |
|
| 17 | ## I came here because I want to...
|
| 18 |
|
| 19 | - Understand how Cycle.js works in general: go to http://cycle.js.org
|
| 20 | - Understand how Cycle *Core* itself works: read the [docs](https://github.com/cyclejs/cycle-core/blob/master/docs/api.md) and the [tests](https://github.com/cyclejs/cycle-core/tree/master/test)
|
| 21 | - File a bug report for anything Cycle-related: [open an issue](https://github.com/cyclejs/cycle-core/issues/new)
|
| 22 | - Ask a question such as "How do I ...?": [open a StackOverflow question with `cyclejs` tag](http://stackoverflow.com/questions/tagged/cyclejs) or ask in the [Gitter chat room](https://gitter.im/cyclejs/cycle-core)
|
| 23 | - Contribute a new driver: [open an issue](https://github.com/cyclejs/cycle-core/issues/new)
|
| 24 |
|
| 25 | ## LICENSE
|
| 26 |
|
| 27 | [The MIT License (MIT)](https://github.com/cyclejs/cycle-core/blob/master/LICENSE)
|
| 28 |
|
| 29 | - - -
|
| 30 |
|
| 31 | [](https://travis-ci.org/cyclejs/cycle-core)
|
| 32 | [](https://codeclimate.com/github/cyclejs/cycle-core)
|
| 33 | [](https://david-dm.org/cyclejs/cycle-core)
|
| 34 | [](https://david-dm.org/cyclejs/cycle-core#info=devDependencies)
|
| 35 | [](http://js.org)
|