Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bouzidanas committed Jan 26, 2024
1 parent 8227afc commit f84a104
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,6 @@ You can install it using the following command:
```bash
npm install react-list-player
```
You can also install it directly from GitHub using the following command:

```bash
npm install bouzidanas/react-list-player
```
If you want to work straight from the source code, you will need to fork the repository and clone it to your local machine. Then you will need to make sure it is in "demo-mode" and not "lib-mode". To do this, just run the command:
```bash
npm run demo
```
from the root directory of the repository. As a test, you can run the command `npm run dev` to launch the demo app.

>[!NOTE]
>Versions up to and including Version 1.0.0 use TailwindCSS. If you are using a later version, you can skip the tailwindCSS installation and configuration instructions.
Expand Down Expand Up @@ -382,6 +372,19 @@ Finally, there is a headless mode where only the playlist is rendered. This is d
[![Static Badge](https://img.shields.io/badge/Demo-415a77?style=for-the-badge)](https://react-list-player.vercel.app/) :arrow_left: *(Click here to see a demo of the ListPlayer component)*
## Contributing
Pull requests are welcome.
For major changes, please open an issue first to discuss what you would like to change.
>[!WARNING]
>If, for some reason, this repo is in lib-mode (it shouldnt be), you will need to make sure it is in demo-mode before you make a pull request. To do this, just run the command:
>```bash
>npm run demo
>```
>from the root directory of the repository. It is recommended that you switch to demo-mode before making changes. As a test, you can run the command `npm run dev` to launch the demo app (which will not work if in lib-mode).
## License
[![Static Badge](https://img.shields.io/badge/License-MIT-415a77?style=for-the-badge)](https://github.com/bouzidanas/react-list-player/blob/master/LICENSE)

0 comments on commit f84a104

Please sign in to comment.