vhad/dash-player
1
0
Fork 0
mirror of https://github.com/gosticks/dash-player.git synced 2025-10-16 11:55:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README and CONTRIBUTING

Browse Source
This commit is contained in:
Alex Hsu 2022-10-20 16:04:32 -04:00
parent 93b3a91892
commit 6b6512d2ee
2 changed files with 19 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.md
View File

@ -1,4 +1,20 @@
# CONTRIBUTING
This project was generated by the [dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate) it contains the minimal set of code required to create your own custom Dash component.
## Build manually
To generate builds manually, run the following:
```sh
$ npm install webpack webpack-cli
$ npm run build
```
## Usage
`usage.py` provides you with the basic functionality of the app. Use it to learn the most basic implementation of a Dash Player component.
`usage-methods.py` allows you to test properties that are updated at an interval.
`usage-advanced.py` gives an overview of the full functionality of the component, and serves as an extensive testing tool.
This project was generated by the [dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate) it contains the minimal set of code required to create your own custom Dash component.

25
README.md
View File

@ -14,30 +14,9 @@ This is a custom community component, so if your organization or company is inte
Here are the following steps to get started with using Dash Player in your own Dash apps
```sh
$ git clone https://github.com/plotly/dash-player
$ cd dash-player
$ npm install
$ pip install dash-player
```
Once that's done, you can copy the `dash_player` package in the folder of your app, and import it within your app.
## Build manually
To generate builds manually, run the following:
```sh
$ npm install webpack webpack-cli
$ npm run build
```
## Usage
`usage.py` provides you with the basic functionality of the app. Use it to learn the most basic implementation of a Dash Player component.
`usage-methods.py` allows you to test properties that are updated at an interval.
`usage-advanced.py` gives an overview of the full functionality of the component, and serves as an extensive testing tool.
## Documentation
| Prop | Description | Default |
@ -76,7 +55,7 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc
- **Xing Han** - _Initial Work_ - [@xhlulu](https://github.com/xhlulu)
- **Alex Hsu** - _Maintainer/Ongoing Developer_ - [@alexshoe](https://github.com/alexshoe)
- **Chris** - _Code Review_
- **Alex Johnson** - _Code Review_ - [@alexcjohnson](https://github.com/alexcjohnson)
See also the list of [contributors](https://github.com/xhlulu/dash-player/contributors) who participated in this project.