Merge pull request #83 from mateuszskoczek/docs/readme

readme
This commit is contained in:
2024-03-10 23:52:06 +01:00
committed by GitHub
Unverified
2 changed files with 8 additions and 26 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 217 KiB

After

Width:  |  Height:  |  Size: 94 KiB

View File

@@ -1,7 +1,7 @@
# VDownload # VDownload
VDownload is universal video downloader written in .NET/C# and Universal Windows Platform. VDownload is universal video downloader written in .NET/C# and Universal Windows Platform.
![VDownload Home Page](.github/Images/Home.png) ![VDownload Home Page](.github/images/Home.png)
## Requirements ## Requirements
@@ -10,8 +10,8 @@ VDownload is universal video downloader written in .NET/C# and Universal Windows
## Download and installation ## Download and installation
- Microsoft Store
- GitHub Releases - GitHub Releases
- Microsoft Store (in the future)
@@ -19,26 +19,24 @@ VDownload is universal video downloader written in .NET/C# and Universal Windows
#### Supported sources #### Supported sources
- Twitch (VODs, clips and channels) - Twitch (VODs, clips and channels)
- YouTube (Videos, playlists and channels)
#### Features #### Features
- Intuitive and easy to use - Intuitive and easy to use
- Modern GUI, consistent with Windows, touchscreen friendly - WinUI - Modern GUI, consistent with Windows, touchscreen friendly
- Multiple video service support - one app for all - Multiple video service support - one app for all
- Video downloading - Video downloading
- Audio-only, video-only and audio-video downloading - Audio-only, video-only and audio-video downloading
- Time trimming - download only the fragment you need - Time trimming - download only the fragment you need
- Task scheduling - start downloading after a certain amount of time
- Playlist downloading - Playlist downloading
- Playlist filtering - download only the videos you need - Playlist filtering - download only the videos you need
- Playlist subscription - download new videos from saved playlists - Playlist subscription - download new videos from saved playlists
- Downloading queue - Downloading queue
- Use of native Windows media transcoding libraries - no FFmpeg included - FFmpeg transcoding
- Highly configurable - from default video downloading parameters to transcoding algorithm - Highly configurable - from default video downloading parameters to transcoding options
and everything for free with open source code and all of this for free
@@ -46,26 +44,10 @@ and everything for free with open source code
VDownload is a project, which I develop in my free time as a hobby and a form of learning. VDownload is a project, which I develop in my free time as a hobby and a form of learning.
As the application is not 100% resistant to external factors (e.g. changes in APIs) and to be fair to creators and video services, it is available for free. As the application is not 100% resistant to external factors (e.g. changes in services APIs) and to be fair to creators and video services, it is available for free with open source code.
If you want to support me and the development of the project you can: If you want to support me and the development of the project you can:
- **Donate me** via Paypal (link in the "Sponsor this project" section in Github repository and in the app itself in the "About" page) - **Donate me** via Paypal (link in the "Sponsor this project" section in Github repository and in the app itself in the "About" page)
- **Report bugs and errors** in the "Issues" section of Github repository - **Report bugs and errors** in the "Issues" section of Github repository
- **Propose new features and support of video services** in the "Issues" section of Github repository - **Propose new features and support of video services** in the "Issues" section of Github repository
- **Translate the application into a language you know** - **Translate the application into a language you know**
#### App development status
At the moment, the application is in the **early stage of development**. Only source code is available to download. Check "App development plans" to learn about further project development plans.
#### App development plans
- **1.0-prerelease1** - with Twitch support only, all video and playlist download options and playlist subscription *[Q2 2022]*
- **1.0-prerelease2** - Youtube support and issues from 1.0-prelease1 closed *[Q3 2022]*
- **1.0** - issues from 1.0-prelease2 closed and support for Polish (and maybe German) language *[Q3 2022]*
- **1.?** - new video services and language support and closing issues from previous versions. *[?]*
- **2.0** - switch from Universal Windows Platform to Windows App SDK *[when Windows App SDK will be more developed and will offer elements which I use in UWP (e.g. Mica)]*
**dates are indicative only and may change*