Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lucasintel committed Feb 19, 2021
1 parent b2f6bac commit 14036e2
Showing 1 changed file with 73 additions and 9 deletions.
82 changes: 73 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,36 @@
![Integration Tests](https://github.com/kandayo/likee-scraper/workflows/Integration%20Tests/badge.svg)
[![GitHub release](https://img.shields.io/github/release/kandayo/likee-scraper.svg?label=Release)](https://github.com/kandayo/likee-scraper/releases)

Download videos **without watermark** from Likee.
Download videos (and their metadata) from Likee.

**Work in progress, but decently usable.**
The videos are downloaded in their original quality, with no watermark.

See also: [**Likee.cr - Unofficial Likee API wrapper for Crystal**](https://github.com/kandayo/likee.cr).
See also: [**Likee API Wrapper**](https://github.com/kandayo/likee.cr).

## Index

- [Features](#features)
- [Disclaimer](#disclaimer)
- [Installation](#installation)
- [Usage](#usage)
- [Download profile by @username](#download-profile-by-username)
- [Download profile by ID](#download-profile-by-id)
- [Batch file](#batch-file)
- [Fast update](#fast-update)
- [Contributing](#contributing)
- [Contributors](#contributors)

## Features

<p align="center">
<img src="https://user-images.githubusercontent.com/43556511/108448057-ee8f7680-7258-11eb-90bd-7f253b3d0b4f.png" alt="Terminalizer">
</p>

- Download profiles by @username.
- Download profiles by User ID.
- Built for archivists in mind: smart fast update.
- Extract metadata from entities.
- Batch file, cronjob friendly.

## Disclaimer

Expand Down Expand Up @@ -42,15 +67,54 @@ shards build --release

## Usage

For more examples, please refer to the [**documentation**](https://kandayo.github.io/likee-scraper/Likeer.html).
For more examples, please refer to the [**documentation**](https://absolab.xyz/likee-scraper).

### Download profile by @username

Looking up a user by username requires an additional API request. It's strongly
recommended to use User IDs. Usernames must be prefixed with an "@".

```bash
# Archive the user feed, but stop when encountering the first already-downloaded post.
# Note: this is the default behaviour.
likeer store --fast-update <USER>
$ likeer -u @username
```

### Download profile by ID

# Archive the last 5 posts of <USER>.
likeer store -n 5 <USER>
If a identifier does not have a prefix, it is assumed to be an User ID.

```bash
$ likeer -u 11111111
```

### Batch file

If `--batch-file <file.txt>` (or `-a`) is given, Likee will read *file.txt*
expecting @usernames and IDs to download, one identifier per line.
Lines starting with "#" or empty lines are considered as comments and ignored.

Usernames must be prefixed with an "@", e.g. `@username`.

IDs must not be prefixed with an "@", e.g. `1111111`.

```bash
$ cat batch.txt
~> # Comment (ignored)
~> @username
~> 111111111
$ likeer -a batch.txt
```

### Fast update

If `--fast-update` (or `-f`) is given, Likeer stops when arriving at the
first already downloaded video. This flag is recommended when you use Likeer
to update your personal Likee archive.

```bash
$ likeer -u @username -f
# => Example Username - 000003.mp4 [========================] 12.1 MB / 12.1 MB
# => Example Username - 000002.mp4; skipping
# => User @username in sync!
```

## Contributing
Expand Down

0 comments on commit 14036e2

Please sign in to comment.