Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
vihu committed Nov 20, 2023
1 parent f2f90ff commit 00c63a0
Showing 1 changed file with 29 additions and 4 deletions.
33 changes: 29 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,39 @@
# iptvrs

Playlist parser and search support for m3u4u playlist locally!

## What does this do?

- Gets your [m3u4u](https://m3u4u.com/) playlist.
- Stores it locally in [sled](https://github.com/spacejam/sled) database with custom channel indexing.
- Allows searching for channels.
- Supports playing a channel with your choice of local player.

## Requirements

- [Rust](https://www.rust-lang.org/) (rustc 1.70.0+).

## Setup

- Clone this repo `git clone <this_repo_url>`.
- Copy `settings.template.toml` to `~/.config/iptvrs/settings.toml`, edit your
`settings.toml` accordingly. The template file is commented for reference.
- Clone this repo:

```
$ git clone https://github.com/vihu/iptvrs.git
```

- Create the config directory:

```
$ mkdir -p $HOME/.config/iptvrs
```

- Copy settings:

```
$ cp settings.template.toml $HOME/.config/iptvrs/settings.toml
```

Edit the `settings.toml` as necessary (it is commented for reference).

## Build

Expand All @@ -18,7 +43,7 @@ In the repo root folder:
$ cargo build --release
```

Optionally you can copy the binary to somewhere in your path:
Optional (but recommended), copy the binary to somewhere in your path:

```
$ cp ./target/release/iptvrs ~/.bin
Expand Down

0 comments on commit 00c63a0

Please sign in to comment.