Skip to content

Commit

Permalink
docs: 📝 update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam Simpson committed Aug 3, 2020
1 parent 76a1174 commit 0cee91f
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 9 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "oscar"
version = "0.1.19"
version = "0.1.20"
authors = ["Adam Simpson <adam@heysparkbox.com>"]
edition = "2018"
description = "A CLI application to download videos from PBS. Ideally run in cron or another scheduler."
Expand Down
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 0cee91f

Please sign in to comment.