@cycle/core
Version:
The Cycle run() function meant to be used with RxJS v4
36 lines (23 loc) • 1.99 kB
Markdown
<h1>
<img src="https://raw.github.com/cyclejs/cycle-core/master/logo.png" /> Cycle.js
</h1>
> Cycle.js is a fully reactive JavaScript framework for Human-Computer Interaction.
Cycle *Core* is the minimum required tools you need for building applications. It is comprised of one single function, `Cycle.run(main, drivers)`.
## Installing
[](http://badge.fury.io/js/%40cycle%2Fcore)
`npm install rx @cycle/core`
Note: `rx` is a **required** dependency. Without it, nothing will change.
## I came here because I want to...
- Understand how Cycle.js works in general: go to http://cycle.js.org
- 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)
- File a bug report for anything Cycle-related: [open an issue](https://github.com/cyclejs/cycle-core/issues/new)
- 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)
- Contribute a new driver: [open an issue](https://github.com/cyclejs/cycle-core/issues/new)
## LICENSE
[The MIT License (MIT)](https://github.com/cyclejs/cycle-core/blob/master/LICENSE)
- - -
[](https://travis-ci.org/cyclejs/cycle-core)
[](https://codeclimate.com/github/cyclejs/cycle-core)
[](https://david-dm.org/cyclejs/cycle-core)
[](https://david-dm.org/cyclejs/cycle-core#info=devDependencies)
[](http://js.org)