Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yairp03 authored Aug 29, 2022
2 parents 5ba6d15 + 31fb744 commit 99a2915
Showing 1 changed file with 43 additions and 1 deletion.
44 changes: 43 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,45 @@
# HoradotTV
Next generation of my SdarotTV Downloader
Downloader for SdarotTV

## SdarotAPI
The SdarotAPI is a library allowing:
- Access metadata of shows, seasons and episodes.
- Get access to SdarotTV's media servers.
- Download episodes from SdarotTV.
- Retrieve the most updated SdarotTV domain.

## Console App
The console app is a command line application that utilizes the SdarotAPI library, with the power to Download in 4 different download modes:
- Single episode download.
- Multiple episode download.
- Complete season download.
- Complete show download.

With some more features like retries on server errors, and division to folders.

### Running The Console App
The easiest way to use the console app is through the release on Github:

1. Go to the [releases](https://github.com/yairp03/HoradotTV/releases) page.
2. Download the latest `HoradotTV.Console.zip` file.
3. Extract the zip.
4. Run the `HoradotTV.Console.exe` file.

#### Running With Visual Studio
If you want to build the project from source, you can do that by using Visual Studio:

1. Open the `HoradotTV.Console.sln` file with Visual Studio.
2. Select the console app as startup project.
3. Press `F5` to run.


## GUI App
The GUI app is currently on hold. Contributors who are willing to help use the SdarotAPI library to build the GUI app are welcome to contact me.

## Future Development
- GUI app.
- SdarotAPI for python.

## Contributing
If you find any bugs or have any suggestions, please open an issue on [Github](https://github.com/yairp03/HoradotTV/issues).
Contributors can check the [issues](https://github.com/yairp03/HoradotTV/issues) page for open issues and help make this project the best.

0 comments on commit 99a2915

Please sign in to comment.