Skip to content
This repository has been archived by the owner on Oct 6, 2024. It is now read-only.

Commit

Permalink
Added README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nyah Check committed Jul 31, 2017
1 parent 5b2f354 commit bf4e95b
Showing 1 changed file with 54 additions and 1 deletion.
55 changes: 54 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,55 @@
# ytd
Youtube Downloader
A Go Application for downloading Youtube videos and mp3


## Pre requisites

* [Go version 1.8](https://github.com/golang/go/releases/tag/go.1.8.3)
* [Docker CE 17.06](https://docs.docker.com/release-notes/docker-ce/)

Clone GIT repo:
```
$ git clone htps://github.com/Ch3ck/ytd
$ go get -u google.golang.org/api/youtube/v3
$ go get -u golang.org/x/oauth2/...
``
## Build
The make command builds the code, runs the tests, generates and runs the docker containers.
```
$ make
```
## Kickstart usage
On a Linux or OSX system
```
$ ./ytd <link to youtube video>
```
## Roadmap
* Search for Youtube vidoes based on the Link and provides the download options for either mp3 or flv file
* Support HD Video download
* Support search with Youtube API, process results and user chooses whatever files to download
* Multithreaded downloads
* Web App(PWA, Basic JS Web UI)
* Package for OSX, Android, iOS
## Contributing
Start by starring and Forking this repository. Follow the basic instruction in the [CONTRIBUTING](CONTRIBUTING) file.
## Licence
YTD is licensed under [The MIT Licence](LICENSE).
##Author
This project was created and maintained by [Nyah Check](https://twitter.com/nyah_check). Please feel free to reach out, I could always use your help or advice :-)

0 comments on commit bf4e95b

Please sign in to comment.