From 504d1eab454d8888417c0325f35db37156a3780b Mon Sep 17 00:00:00 2001 From: Leo Robinovitch Date: Thu, 21 Dec 2023 09:27:00 -0800 Subject: [PATCH] readme --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9bdbdbb --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# webtoon-dl + +Download [webtoon](https://www.webtoons.com/en/) comics as PDFs using a terminal/command line. + +## Installation + +### Homebrew + +```shell +brew install robinovitch61/tap/webtoon-dl + +# to upgrade +brew update && brew upgrade webtoon-dl +``` + +### Download from Github + +Download the relevant binary for your operating system (macos = darwin) from +the [latest github release](https://github.com/robinovitch61/webtoon-dl/releases). unpack it, then move the binary to +somewhere accessible in your `path`, e.g. `mv ./webtoon-dl /usr/local/bin`. + +### Using [go installed on your machine](https://go.dev/doc/install) + +```shell +go install github.com/robinovitch61/webtoon-dl@latest +``` + +### Build from Source + +Clone this repo, build from source with `cd && go build`, then move the binary to somewhere accessible in +your `path`, e.g. `mv ./webtoon-dl /usr/local/bin`. + +## Usage + +```shell +webtoon-dl +```