README file updated

README.md

@@ -1,89 +1,44 @@
-# Project Title
+# YDL: Youtube Downloader
 
 Ydl is a simple python program that downloads youtube videos, converts them into
 audio file and creates an xml file to listen to them as a podcast. 
 
 ## Getting Started
 
-These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+usage: ydl.py [-h] [-s] [-q] [-f] [-video] [-d DIR] [-url URL]
+              [-yturl YOUTUBE_URL]
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -s, --simulate        Do not download videos, just do as if
+  -q, --quiet           Very quiet option for youtube-dl
+  -f, --feed            Create Podcast feed
+  -video                Download videos instead of creating audio
+  -d DIR, --dir DIR     Define download directory for files, default
+                        value:'~/Vidéos'
+  -url URL              Define base url for podcasts, default
+                        value:'http://podcasts.lutix.org'
+  -yturl YOUTUBE_URL, --youtube_url YOUTUBE_URL
+                        Define youtube url to fetch
+
 
 ### Prerequisites
 
-What things you need to install the software and how to install them
+Please check requirements.txt.
-
-```
-Give examples
-```
 
 ### Installing
 
-A step by step series of examples that tell you how to get a development env running
+Either use binary ydl in dist folder (under Linux OS only) or run python3 over ydl.py.
-
-Say what the step will be
-
-```
-Give the example
-```
-
-And repeat
-
-```
-until finished
-```
-
-End with an example of getting some data out of the system or using it for a little demo
-
-## Running the tests
-
-Explain how to run the automated tests for this system
-
-### Break down into end to end tests
-
-Explain what these tests test and why
-
-```
-Give an example
-```
-
-### And coding style tests
-
-Explain what these tests test and why
-
-```
-Give an example
-```
-
-## Deployment
-
-Add additional notes about how to deploy this on a live system
-
-## Built With
-
-* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
-* [Maven](https://maven.apache.org/) - Dependency Management
-* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
-
-## Contributing
-
-Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
-
-## Versioning
-
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). 
 
 ## Authors
 
-* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
+* **fabthegreat** - *Initial work* - fabthegreat@lutix.org
-
-See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
+This project is not yet licensed. 
 
 ## Acknowledgments
 
-* Hat tip to anyone whose code was used
+* youtube-dl library.
-* Inspiration
-* etc