Skip to content

Commit

Permalink
fix: Dropped stateEffects for a while. Added stubs for docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
mnasyrov committed Jul 26, 2021
1 parent c26cf19 commit 566ab80
Show file tree
Hide file tree
Showing 8 changed files with 25,863 additions and 25,965 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,29 @@ Reactive state and effect management with RxJS.
[![licence](https://img.shields.io/github/license/mnasyrov/rx-effects.svg)](https://github.com/mnasyrov/rx-effects/blob/master/LICENSE)
[![Coverage Status](https://coveralls.io/repos/github/mnasyrov/rx-effects/badge.svg)](https://coveralls.io/github/mnasyrov/rx-effects)

## Documentation
## Features

`// TODO: Documentation`
- Declarative effects
- Reactive state store
- Effect container
- Typescript typings
- Framework agnostic
- Simple and functional API

## Packages

- [`rx-effects`](packages/rx-effects/README.md) – core state and effect management, [API](packages/rx-effects/docs)
- [`rx-effects-react`](packages/rx-effects-react/README.md) – tooling for React.js, [API](packages/rx-effects-react/docs)

## Installation

Inspired by [MVC](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller), [RxJS](https://github.com/ReactiveX/rxjs), [Akita](https://github.com/datorama/akita) and [Effector](https://github.com/effector/effector).
```
npm install rx-effects --save
```

## Usage

`// TODO: Documentation`

## License

Expand Down
Loading

0 comments on commit 566ab80

Please sign in to comment.