[skyitalia] fixed coding conventions

[yt-dlp.git] / README.md

diff --git a/README.md b/README.md
index 2d8bd9b8524049dc8c9b35b7fd7963397ef91d82..5532cd720594040a967b7a363032c8c0f880915f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,13 @@
-[![PyPi](https://img.shields.io/pypi/v/youtube-dlc.svg)](https://pypi.org/project/youtube-dlc)
 [![Build Status](https://travis-ci.com/blackjack4494/youtube-dlc.svg?branch=master)](https://travis-ci.com/blackjack4494/youtube-dlc)
+[![PyPi](https://img.shields.io/pypi/v/youtube-dlc.svg)](https://pypi.org/project/youtube-dlc)
 [![Downloads](https://pepy.tech/badge/youtube-dlc)](https://pepy.tech/project/youtube-dlc)
 
-[![Gitter chat](https://badges.gitter.im/youtube-dlc/gitter.png)](https://gitter.im/youtube-dlc) 
+[![Gitter chat](https://img.shields.io/gitter/room/youtube-dlc/community)](https://gitter.im/youtube-dlc) 
 [![License: Unlicense](https://img.shields.io/badge/license-Unlicense-blue.svg)](https://github.com/blackjack4494/youtube-dlc/blob/master/LICENSE)
 
 youtube-dlc - download videos from youtube.com or other video platforms.
 
-youtube-dlc is a fork of youtube-dl with the intention of getting features tested by the community merged in the tool faster, since youtube-dl's development seems to be slowing down. (https://github.com/ytdl-org/youtube-dl/issues/26462)
+youtube-dlc is a fork of youtube-dl with the intention of getting features tested by the community merged in the tool faster, since youtube-dl's development seems to be slowing down. (https://web.archive.org/web/20201014194602/https://github.com/ytdl-org/youtube-dl/issues/26462)
 
 - [INSTALLATION](#installation)
 - [DESCRIPTION](#description)
@@ -36,6 +36,7 @@
 - [VIDEO SELECTION](#video-selection-1)
 
 # INSTALLATION
+[How to update](#update)
 
 **All Platforms**  
 Preferred way using pip:  
@@ -46,16 +47,16 @@ # INSTALLATION
 **UNIX** (Linux, macOS, etc.)  
 Using wget:
 
-    sudo wget https://github.com/blackjack4494/youtube-dlc/releases/latest/download/youtube-dlc -O /usr/local/bin/youtube-dlc
+    sudo wget https://github.com/blackjack4494/yt-dlc/releases/latest/download/youtube-dlc -O /usr/local/bin/youtube-dlc
     sudo chmod a+rx /usr/local/bin/youtube-dlc
 
 Using curl:
 
-    sudo curl -L https://github.com/blackjack4494/youtube-dlc/releases/latest/download/youtube-dlc -o /usr/local/bin/youtube-dlc
+    sudo curl -L https://github.com/blackjack4494/yt-dlc/releases/latest/download/youtube-dlc -o /usr/local/bin/youtube-dlc
     sudo chmod a+rx /usr/local/bin/youtube-dlc
 
 
-**Windows** users can download [youtube-dlc.exe](https://github.com/blackjack4494/youtube-dlc/releases/latest/download/youtube-dlc.exe) (**do not** put in `C:\Windows\System32`!).  
+**Windows** users can download [youtube-dlc.exe](https://github.com/blackjack4494/yt-dlc/releases/latest/download/youtube-dlc.exe) (**do not** put in `C:\Windows\System32`!).  
 
 **Compile**
 To build the Windows executable yourself (without version info!)
@@ -77,6 +78,10 @@ # INSTALLATION
     make
 
 
+# UPDATE
+**DO NOT UPDATE using `-U` !** instead download binaries again or when installed with pip use a described above when installing.  
+I will add some memorable short links to the binaries so you can download them easier.
+
 # DESCRIPTION
 **youtube-dlc** is a command-line program to download videos from YouTube.com and a few more sites. It requires the Python interpreter, version 2.6, 2.7, or 3.2+, and it is not platform specific. It should work on your Unix box, on Windows or on macOS. It is released to the public domain, which means you can modify it, redistribute it or use it however you like.
 
@@ -298,6 +303,8 @@ ## Filesystem Options:
                                      may change.
     --no-cache-dir                   Disable filesystem caching
     --rm-cache-dir                   Delete all filesystem cache files
+    --trim-file-name                 Limit the filename length (extension
+                                     excluded)
 
 ## Thumbnail images:
     --write-thumbnail                Write thumbnail image to disk
@@ -368,6 +375,8 @@ ## Workarounds:
                                      before each download (maximum possible
                                      number of seconds to sleep). Must only be
                                      used along with --min-sleep-interval.
+    --sleep-subtitles                Enforce sleep interval on subtitles as well.
+
 
 ## Video Format Options:
     -f, --format FORMAT              Video format code, see the "FORMAT
@@ -775,4 +784,4 @@ # Download only the videos uploaded on January 1, 1970
 
 $ # Download only the videos uploaded in the 200x decade
 $ youtube-dlc --dateafter 20000101 --datebefore 20091231
-```
\ No newline at end of file
+```