From 0cee91fd241e4d985e3e2c7d2ed320ff23e563bb Mon Sep 17 00:00:00 2001 From: Adam Simpson Date: Mon, 3 Aug 2020 11:14:42 -0400 Subject: [PATCH] docs: :memo: update README. --- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 29 ++++++++++++++++++++++------- 3 files changed, 24 insertions(+), 9 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 77cdd88..d96bfa2 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -768,7 +768,7 @@ dependencies = [ [[package]] name = "oscar" -version = "0.1.19" +version = "0.1.20" dependencies = [ "dirs 2.0.2 (registry+https://github.com/rust-lang/crates.io-index)", "log 0.4.8 (registry+https://github.com/rust-lang/crates.io-index)", diff --git a/Cargo.toml b/Cargo.toml index 1cdf533..11837bb 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "oscar" -version = "0.1.19" +version = "0.1.20" authors = ["Adam Simpson "] edition = "2018" description = "A CLI application to download videos from PBS. Ideally run in cron or another scheduler." diff --git a/README.md b/README.md index 6dff039..4bdaf8d 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,41 @@ # Oscar [![Build Status](https://travis-ci.org/asimpson/oscar.svg?branch=master)](https://travis-ci.org/asimpson/oscar) -A CLI application to download Sesame Street videos from PBS. Ideally run in cron or another scheduler. +A CLI application to download full TV episodes from PBS. Ideally run in `cron` or another scheduler. ## Example `@hourly oscar -so /mnt/nas/videos/` +## Installation + +### Pre-built binaries +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)). + +### Cargo +`cargo install oscar` + +### From source +Requires Rust and Cargo to be installed on the host system. + +To build: `cargo build --release` + +## Subcommands +`list`: View available shows in "slug" format, e.g. `sesame-street`. + +FYI `oscar` defaults to downloading Sesame Street episodes. + ## Options `-d --dry-run`: run without actually downloading any files. `-s --silent`: Do not log anything. -`-o --output`: Where to save movies, defaults to `/tmp/`. +`-o --output`: Where to save episodes, defaults to `/tmp/`. `-S --show-slug`: What show to download. Get the slug by running `oscar list`. -## Subcommands -`list`: View available shows in "slug" format, e.g. `sesame-street`. - ## Misc -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. +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. 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. -Currently a new episode cycles in on Friday at 1am EST. +Currently new episodes cycle in on Friday at 1am EST.