Skip to content

Commit

Permalink
Merge pull request #6 from ryansukale/improve-readme
Browse files Browse the repository at this point in the history
Improve the README
  • Loading branch information
ryansukale authored Nov 15, 2018
2 parents 7b83505 + 290d13a commit 234f4de
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,17 @@ npm install incrudable --save

---

At this time, this library exposes two implementations for creating CRUD resources - one using `redux-thunk` and another using `redux-observable`.

**NOTE**: If you are using `redux-observable`, this library relies on Rxjs 6+ which has several differences from Rxjs 5. Please see the [Rxjs repository](https://github.com/ReactiveX/rxjs) for more information on backward compatibility and migration.

---

### Philosophy

Having to learn a new library is often a pain. While building incrudable, one of my goals was to allow developers to use all their existing knowledge of `redux-thunks` or `redux-observables`( so it should be 100% compatible with existing codebases), and let this library just provide a bunch of utility functions to reduce boilerplate.
Having to learn a new library is often a pain. While building incrudable, one of my goals was to enable developers to use all their existing knowledge of `redux-thunks` or `redux-observables`( so it should be 100% compatible with existing codebases), and let this library act as a complimentary set of utility functions to reduce boilerplate.

Use as little or as much as you need of this library. There are a few conventions to follow in support the above mentioned lifecycle. Almost everything else is customizable.
Use as little or as much of this library as you need. There are a few conventions to follow if you intend to use the richer functions like the `incrudable` constructor and `fromResource`. Almost everything else plug and play and highly customizable.

---

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "incrudable",
"version": "0.2.0",
"version": "0.2.1",
"description": "Crud utilities for redux based applications",
"main": "lib/index.js",
"module": "es/index.js",
Expand Down

0 comments on commit 234f4de

Please sign in to comment.