lbryinc/README.md

26 lines
941 B
Markdown
Raw Permalink Normal View History

2018-07-03 11:23:46 +02:00
# lbryinc
2018-07-12 22:14:07 +02:00
lbryinc is a module which contains common api.lbry.io and rewards code shared between lbry-desktop and lbry-android.
2018-07-03 11:23:46 +02:00
## Installation
Add `lbryinc` as a dependency to your `package.json` file.
`"lbryinc": "lbryio/lbryinc"`
### 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 lbryinc
2019-10-03 21:05:42 +02:00
yarn link
cd /<path>/<to>/<project> (ex: cd ~/lbry-desktop)
yarn link lbryinc
2018-07-03 11:23:46 +02:00
````
### Build
Run `$ yarn build`. If the symlink does not work, just build the file and move the `bundle.js` file in to the `node_modules/` folder.
2021-06-11 18:23:02 +02:00
### Automatic rebuild
To have the code automatically rebuild upon changes you can run `$ yarn dev` which will use `rollup` to watch the files and build upon detection of updated source code.
2018-07-03 11:23:46 +02:00
## License
[MIT © LBRY](LICENSE)