Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Shineii86 authored May 6, 2024
1 parent e59b8c5 commit 3d2d589
Showing 1 changed file with 76 additions and 0 deletions.
76 changes: 76 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# M3U8 Player

![M3U8 Player Logo](https://example.com/m3u8player_logo.png)

Welcome to M3U8 Player! This is a lightweight JavaScript-based player for playing M3U8 streams. It supports live streaming as well as on-demand playback.

## Features

- Play M3U8 streams effortlessly.
- Supports live streaming and on-demand playback.
- Lightweight and easy to integrate into web applications.
- Customizable player controls.
- Compatible with all modern web browsers.

## Installation

You can use the M3U8 Player library by including the JavaScript file in your HTML code:

```html
<script src="m3u8player.js"></script>
```

## Usage

To use M3U8 Player, simply create a `<video>` element in your HTML code and specify the source URL of the M3U8 stream:

```html
<video id="m3u8-player" controls>
<source src="https://example.com/live/stream.m3u8" type="application/x-mpegURL">
</video>
```

Then, initialize the player using JavaScript:

```javascript
const player = new M3U8Player('m3u8-player');
```

## Demo

Check out the [live demo](https://example.com/m3u8player-demo) to see M3U8 Player in action!

## Contributing

Contributions are welcome! Please feel free to fork this repository, make changes, and submit pull requests.

## Issues

If you encounter any issues or have suggestions for improvement, please [open an issue](https://github.com/Shineii86/m3u8player/issues) on GitHub.

## Support

For support or inquiries, please contact [[email protected]](mailto:[email protected]).

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

---

### Show Your Support

If you find M3U8 Player useful, consider giving it a star on GitHub and sharing it with your friends and colleagues!

[![GitHub stars](https://img.shields.io/github/stars/Shineii86/m3u8player.svg?style=social)](https://github.com/Shineii86/m3u8player/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/Shineii86/m3u8player.svg?style=social)](https://github.com/Shineii86/m3u8player/network/members)

---

### Credits

M3U8 Player is developed and maintained by [Shineii86](https://github.com/Shineii86). If you use this player in your project, please give proper credit.

---

Feel free to customize the README.md further to fit your specific needs.

0 comments on commit 3d2d589

Please sign in to comment.