Skip to content

Commit 0cee91f

Browse files
author
Adam Simpson
committed
docs: 📝 update README.
1 parent 76a1174 commit 0cee91f

File tree

3 files changed

+24
-9
lines changed

3 files changed

+24
-9
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "oscar"
3-
version = "0.1.19"
3+
version = "0.1.20"
44
authors = ["Adam Simpson <adam@heysparkbox.com>"]
55
edition = "2018"
66
description = "A CLI application to download videos from PBS. Ideally run in cron or another scheduler."

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,41 @@
11
# Oscar
22
[![Build Status](https://travis-ci.org/asimpson/oscar.svg?branch=master)](https://travis-ci.org/asimpson/oscar)
33

4-
A CLI application to download Sesame Street videos from PBS. Ideally run in cron or another scheduler.
4+
A CLI application to download full TV episodes from PBS. Ideally run in `cron` or another scheduler.
55

66
## Example
77
`@hourly oscar -so /mnt/nas/videos/`
88

9+
## Installation
10+
11+
### Pre-built binaries
12+
Pre-built binaries are available via [Github releases](https://github.com/asimpson/oscar/releases) (which are built by [TravisCI](https://travis-ci.org/asimpson/oscar)).
13+
14+
### Cargo
15+
`cargo install oscar`
16+
17+
### From source
18+
Requires Rust and Cargo to be installed on the host system.
19+
20+
To build: `cargo build --release`
21+
22+
## Subcommands
23+
`list`: View available shows in "slug" format, e.g. `sesame-street`.
24+
25+
FYI `oscar` defaults to downloading Sesame Street episodes.
26+
927
## Options
1028
`-d --dry-run`: run without actually downloading any files.
1129

1230
`-s --silent`: Do not log anything.
1331

14-
`-o --output`: Where to save movies, defaults to `/tmp/`.
32+
`-o --output`: Where to save episodes, defaults to `/tmp/`.
1533

1634
`-S --show-slug`: What show to download. Get the slug by running `oscar list`.
1735

18-
## Subcommands
19-
`list`: View available shows in "slug" format, e.g. `sesame-street`.
20-
2136
## Misc
22-
Please note that each episode of Sesame Street at ~720p quality is `~500MB`. If you are on a metered or a slow connection this may be a problem.
37+
Please note that each episode at ~720p quality is around `500MB`. If you are on a metered or a slow connection this may be a problem.
2338

2439
Every episode that is downloaded gets logged by appending its ID to a text file `~/.oscar_history`. This file is checked every time `oscar` runs to validate if an episode is new or not.
2540

26-
Currently a new episode cycles in on Friday at 1am EST.
41+
Currently new episodes cycle in on Friday at 1am EST.

0 commit comments

Comments
 (0)