formatting for the README

This commit is contained in:
josuah 2016-12-23 19:13:21 +00:00
parent 3326f08335
commit fb510dc980

View File

@ -1,4 +1,4 @@
#Shelltube ![Shelltube](https://cloud.githubusercontent.com/assets/7250745/21452795/52fcd6ea-c901-11e6-871b-bd646f2d7c49.png)
Shelltube is a collection of (pretty POSIX) shell scripts to Shelltube is a collection of (pretty POSIX) shell scripts to
browse YouTube quickly, efficiently, and without the bloat browse YouTube quickly, efficiently, and without the bloat
@ -23,65 +23,72 @@ 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.*
(cls) clear
*Clear the screen.*
(dl) download [URL]
*Download the selected/specified video.*
exit
*Exit Shelltube.*
(?) help
*Display this message.*
(md) metadata [URL]
*Display selected/specified video's MD.*
(/) search {term}
*Perform a search.*
(str) stream [URL]
*Stream the selected/specified video.*
(sel) video {URL}
*Select video based on URL or ID.*
In (parenthesis), smaller aliases for the commands are written. | (short) command syntax | description |
In {curly brackets}, required arguments are written. | --- | --- |
| (`!`) `about` | View the about page. |
| (`cls`) `clear` | Clear the screen. |
| (`dl`) `download [URL] ` | Download the selected/specified video. |
| `exit` | Exit Shelltube. |
| (`?`) `help` | Display this message. |
| (`md`) `metadata [URL]` | Display selected/specified video's metadata. |
| (`/`) `search TERM` | Perform a search for `TERM`. |
| (`str`) `stream [URL]` | Stream the selected/specified video. |
| (`sel`) `video URL` `video ID` | Select video based on `URL` or `ID`. |
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
**B)** By doing something and specifying the video
Method A entails using either the "video" or "search" command 1. By selecting a video and then doing something with it
to select a video, which will then be displayed before the prompt 2. By doing something and specifying the video
like so:
$VIDEO-ID-HERE \>\> Method A entails using either the `video` or `search`
When a video is selected, you use the "download", "stream", or command to select a video, which will then be displayed
"metadata" commands without arguments to act on the video. before the prompt like so:
```
$VIDEO-ID-HERE >>
```
When a video is selected, you use the `download`, `stream`,
or `metadata` commands without arguments to act on the
video.
Method B entails just using the `download`, `stream`, or
`metadata` commands while using a URL or video ID as an
argument.
Method B entails just using the "download", "stream", or
"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
just use the yt-down.sh, yt-search.sh, and yt-metadata.sh scripts instead just use the `yt-down`, `yt-search`, and
on their own. `yt-metadata` scripts on their own.
They are each pretty simple, and you can read their USAGE messages They are each pretty simple, and you can read their USAGE
at the top of each script. messages at the top of each script.
Licensing Licensing
----------- -----------
All of ST is released under the ISC license All of ST is released under the
(https://opensource.org/licenses/ISC) [ISC](https://opensource.org/licenses/ISC) license.
except for the yt-down.sh script, which is released under the GPLv2
(https://www.gnu.org/licenses/gpl-2.0.html) Except for the `yt-down` script, which is released under the
[GPLv2](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`