Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
typicode committed Jan 2, 2019
1 parent 9677364 commit a6b1c4f
Showing 1 changed file with 3 additions and 11 deletions.
14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,20 @@

> Use any lodash function as a React component
## Introduction

`react-lodash` came out of curiosity.
## Why?

I wanted to know how things could be rewritten with `lodash` as components and if generating them directly from `lodash` JSDoc was possible.

The answer to the latter is obviously yes (otherwise, this repo wouldn't exist :)). Therefore `react-lodash` is a 1:1 mapping with `lodash` API and all components are generated using `npm run generate`.
The answer to the latter is obviously yes. `react-lodash` is therefore a 1:1 mapping with `lodash` API and all components are generated using `npm run generate`.

It also means that not all `react-lodash` components will make sense in a React app. Particularly the ones that mutate data.

> Does it work?
Yes, you can try it on [CodeSandbox](https://codesandbox.io/s/r4lv71wx9q).

> Should you use it?
### Should you use it?

If you have a personal/small project and want to play with `react-lodash`, feel free. Some components might be useful or provide some interesting features.

For bigger projects, you should probably stick to plain JS as it's more familiar and works better with typing systems.

In any case, I had fun building this project and I hope you'll find the idea entertaining :)

## Example

### Without
Expand Down

0 comments on commit a6b1c4f

Please sign in to comment.