jadedctrl/ shellTube
Archived
1
0
Disbranĉigi 0
Fontkodo Issues Tirpetoj Activity

Fix README.md

This commit is contained in:
Jaidyn Ann 2016-12-11 19:37:25 -06:00
parent edc7430360
commit 9a76498159
1 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@ -18,43 +18,43 @@ registration, quotas-- but has some disadvantages. We'll
power through the downsides, though! :) power through the downsides, though! :)
USAGE: Usage
------- -------
Shelltube is quite simple to use; this tutorial will go over Shelltube is quite simple to use; this tutorial will go over
the usage of the wrapper script, shelltube.sh. the usage of the wrapper script, shelltube.sh.
When running the script, you'll see a prompt: When running the script, you'll see a prompt:
>> \>\>
In this prompt you can type any of the following commands: In this prompt you can type any of the following commands:
(!) about View the about page. (!) about View the about page.
(cls) clear Clear the screen. (cls) clear Clear the screen.
(dl) download [URL] Download the selected/specified video. (dl) download [URL] Download the selected/specified video.
exit Exit Shelltube. exit Exit Shelltube.
(?) help Display this message. (?) help Display this message.
(md) metadata [URL] Display selected/specified video's MD. (md) metadata [URL] Display selected/specified video's MD.
(/) search {term} Perform a search. (/) search {term} Perform a search.
(str) stream [URL] Stream the selected/specified video. (str) stream [URL] Stream the selected/specified video.
(sel) video {URL} Select video based on URL or ID. (sel) video {URL} Select video based on URL or ID.
In (parenthesis), smaller aliases for the commands are written. In (parenthesis), smaller aliases for the commands are written.
In {curly brackets}, required arguments are written. In {curly brackets}, required arguments are written.
In [brackets], optional arguments are written. In [brackets], optional arguments are written.
You can use Shelltube in one of two ways (or both): You can use Shelltube in one of two ways (or both):
A) By selecting a video and then doing something with it A) By selecting a video and then doing something with it
B) By doing something and specifying the video B) By doing something and specifying the video
Method A entails using either the "video" or "search" command Method A entails using either the "video" or "search" command
to select a video, which will then be displayed before the prompt to select a video, which will then be displayed before the prompt
like so: like so:
$VIDEO_ID_HERE >> $VIDEO-ID-HERE \>\>
When a video is selected, you use the "download", "stream", or When a video is selected, you use the "download", "stream", or
"metadata" commands without arguments to act on the video. "metadata" commands without arguments to act on the video.
Method B entails just using the "download", "stream", or Method B entails just using the "download", "stream", or
"metadata" commands while using a URL or video ID as an argument. "metadata" commands while using a URL or video ID as an argument.
For example: For example:
>> download $VIDEO_ID_HERE \>\> download $VIDEO-ID-HERE
You could opt to not use this interactive wrapper script and instead You could opt to not use this interactive wrapper script and instead
@ -65,14 +65,14 @@ They are each pretty simple, and you can read their USAGE messages
at the top of each script. at the top of each script.
LICENSING: Licensing
----------- -----------
All of ST is released under the ISC license All of ST is released under the ISC license
(https://opensource.org/licenses/ISC) (https://opensource.org/licenses/ISC)
except for the yt-down.sh script, which is released under the GPLv2 except for the yt-down.sh script, which is released under the GPLv2
(https://www.gnu.org/licenses/gpl-2.0.html) (https://www.gnu.org/licenses/gpl-2.0.html)
CREDIT: Credit
-------- --------
jadedctrl wrote most of ST, but iluaster wrote almost all of jadedctrl wrote most of ST, but iluaster wrote almost all of
yt-down.sh yt-down.sh