Common components refactor #1
2 changed files with 23 additions and 1 deletions
22
README.md
Normal file
22
README.md
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
# lbry-redux
|
||||||
|
lbry-redux is a module which contains common React and redux code shared between lbry-app and lbry-android.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
Add `lbry-redux` as a dependency to your `package.json` file.
|
||||||
|
`"lbry-redux": "lbryio/lbry-redux"`
|
||||||
|
|
||||||
|
### Local development
|
||||||
|
If you intend to make changes to the module and test immediately, you can use `npm link` to add the package to your `node_modules` folder. This will create a symlink to the folder where `lbry-redux` was cloned to.
|
||||||
|
```
|
||||||
|
cd lbry-redux
|
||||||
|
sudo npm link
|
||||||
|
cd /<path>/<to>/<project>/node_modules
|
||||||
|
npm link lbry-redux
|
||||||
|
````
|
||||||
|
|
||||||
|
### Build
|
||||||
|
Run `$ npm build`.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[MIT © LBRY](LICENSE)
|
Loading…
Add table
Reference in a new issue