Skip to content

Commit c3a1a1e

Browse files
authored
Update README.md
1 parent 3bcbac4 commit c3a1a1e

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,55 @@
11
# WebnovelYoinker
22
Downloads and converts webnovels to Epub or PDF
3+
4+
#### Currently supported websites:
5+
- wuxiaworld.com (wuxia)
6+
- crimsonmagic.me (crimsonmagic)
7+
8+
#### Currently supported export formats:
9+
- Epub (epub)
10+
11+
#### Basic usage:
12+
Declaring volumes as YAML file:
13+
14+
```yaml
15+
--- # example-books.yaml
16+
- Author: Park Saenal
17+
CoverImageURL: https://cdn.wuxiaworld.com/images/covers/og.jpg
18+
Language: English
19+
Title: Overgeared Volume 1
20+
Year: 2013
21+
Website : wuxia
22+
ExportFormat : epub
23+
ChapterURLs:
24+
- https://www.wuxiaworld.com/novel/overgeared/og-chapter-1
25+
- https://www.wuxiaworld.com/novel/overgeared/og-chapter-2
26+
- https://www.wuxiaworld.com/novel/overgeared/og-chapter-3
27+
- https://www.wuxiaworld.com/novel/overgeared/og-chapter-4
28+
- https://www.wuxiaworld.com/novel/overgeared/og-chapter-5
29+
- https://www.wuxiaworld.com/novel/overgeared/og-chapter-6
30+
- https://www.wuxiaworld.com/novel/overgeared/og-chapter-7
31+
- https://www.wuxiaworld.com/novel/overgeared/og-chapter-8
32+
- https://www.wuxiaworld.com/novel/overgeared/og-chapter-9
33+
- https://www.wuxiaworld.com/novel/overgeared/og-chapter-10
34+
35+
- Title: Konosuba Volume 1
36+
Author: Natsume Akatsuki
37+
CoverImageURL: https://i.imgur.com/eLIkho2.png
38+
Language: English
39+
Year: 2013
40+
Website : crimsonmagic
41+
ExportFormat : epub
42+
ChapterURLs:
43+
- https://www.crimsonmagic.me/archive/gifting-1-p/
44+
- https://www.crimsonmagic.me/archive/gifting-1-1/
45+
- https://www.crimsonmagic.me/archive/gifting-1-2/
46+
- https://www.crimsonmagic.me/archive/gifting-1-3/
47+
- https://www.crimsonmagic.me/archive/gifting-1-4/
48+
- https://www.crimsonmagic.me/archive/gifting-1-e/
49+
```
50+
Downloading declared books:
51+
```zsh
52+
Linux:
53+
goyoinker scrape -in example-books.yaml -out OUTPUT_DIRECTORY -r 3
54+
```
55+
The flag -r declares how many books should be downloaded in parallel

0 commit comments

Comments
 (0)