Initial commit
This commit is contained in:
commit
0739116bf4
1 changed files with 22 additions and 0 deletions
22
README.md
Normal file
22
README.md
Normal file
|
@ -0,0 +1,22 @@
|
|||
# lbryinc
|
||||
lbryinc is a module which contains common api.lbry.io and rewards code shared between lbry-app and lbry-android.
|
||||
|
||||
## 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
|
||||
sudo npm link
|
||||
cd /<path>/<to>/<project>/node_modules
|
||||
npm link lbryinc
|
||||
````
|
||||
|
||||
### 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.
|
||||
|
||||
## License
|
||||
|
||||
[MIT © LBRY](LICENSE)
|
Loading…
Add table
Reference in a new issue