Skip to content

Commit d4203c3

Browse files
committed
docs: update README
1 parent 2444737 commit d4203c3

File tree

3 files changed

+135
-2
lines changed

3 files changed

+135
-2
lines changed

README.md

Lines changed: 108 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,113 @@
11
# Chytanka
22

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.0.0.
3+
**Chytanka** is a versatile and user-friendly PWA for reading manga, comics, and other visual stories. Whether you prefer to read from popular online platforms, your own server, or local files, Chytanka is here to enhance your reading experience.
4+
5+
## Features
6+
7+
### 🖥️ **Read Episodes Online**
8+
9+
Chytanka supports opening episodes from the following platforms:
10+
11+
- [x] [Blankary](https://blankary.com)
12+
- [x] [Comick](https://comick.io)
13+
- [x] [Imgur](https://imgur.com)
14+
- [x] [Mangadex](https://mangadex.org)
15+
- [x] [Nhentai](https://nhentai.net)
16+
- [x] [Pixiv](https://pixiv.net)
17+
- [x] [Reddit](https://reddit.com)
18+
- [x] [Telegra.ph](https://telegra.ph)
19+
- [x] [Yande.re Pool](https://yande.re/pool)
20+
- [x] [Zenko](https://zenko.online)
21+
22+
### 🌐 **Custom JSON API**
23+
24+
Chytanka can open episodes from any custom JSON API returning the following format:
25+
26+
```json
27+
{
28+
"title": "Title of the episode",
29+
"nsfw": false,
30+
"images": [
31+
{
32+
"src": "full-link-to-image-1"
33+
},
34+
{
35+
"src": "full-link-to-image-2"
36+
},
37+
{
38+
"src": "full-link-to-image-n"
39+
}
40+
]
41+
}
42+
```
43+
44+
### 📚 **Create and Share Readlists**
45+
46+
Compile a readlist using [Chytanka Readlist Creator](https://chytanka.ink/list):
47+
48+
1. Paste supported links into the input field.
49+
2. Edit titles (optional; automatic retrieval supported).
50+
3. Generate and publish a JSON readlist on Rentry, Gist, or your server.
51+
4. Use the generated link to start reading with your custom readlist.
52+
53+
### 📂 **Open Local Files**
54+
55+
Chytanka supports opening the following file formats from your device:
56+
57+
- [x] ZIP/CBZ
58+
- [x] PDF
59+
- [x] MOBI
60+
- [ ] DJVU
61+
- [ ] RAR/CBR
62+
63+
### 📖 **Three Reading Modes**
64+
65+
1. **Vertical**: Perfect for webtoons.
66+
2. **Horizontal (RTL)**: Best for manga.
67+
3. **Horizontal (LTR)**: Ideal for comics.
68+
69+
### 🌓 **Blue Light Filter**
70+
71+
Read comfortably at night with Chytanka's built-in blue light filter.
72+
73+
### 📱 **Responsive Viewing**
74+
75+
- In horizontal mode with landscape orientation: view two pages side by side.
76+
- In portrait orientation: view one page at a time.
77+
78+
### 🖥️ **Fullscreen Mode**
79+
80+
Immerse yourself in reading with a fullscreen option.
81+
82+
### 🕒 **Viewing History**
83+
84+
- [x] Tracks history of supported links.
85+
- [ ] File history support is planned.
86+
87+
### ⌨️ **Keyboard Shortcuts**
88+
89+
#### On the Start Page:
90+
91+
- `F1` — Open FAQ
92+
- `F2` — Open Settings
93+
- `Ctrl+H` — Open History
94+
- `Ctrl+O` — Open File
95+
96+
#### While Reading:
97+
98+
- `A`, `D`, `ArrowLeft`, `ArrowRight` — Navigate pages in horizontal mode
99+
- `W`, `S`, `ArrowUp`, `ArrowDown` — Navigate pages in vertical mode
100+
- `Ctrl+O` — Open File
101+
- `Ctrl+E` — Share (copy link or embed code)
102+
- `F` — Toggle Fullscreen
103+
104+
### 🔞 **NSFW Content Warning**
105+
106+
If supported by the API, Chytanka warns users about NSFW content.
107+
108+
### 🖇️ **Embed Chytanka on Your Website**
109+
110+
Embed Chytanka using an iframe and interact with it via `postMessage`. Learn more in the [Embedding Guide](https://github.com/chytanka/chytanka.github.io/wiki/Embedding-Chytanka-on-Your-Website).
4111

5112
## Development server
6113

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "chytanka",
3-
"version": "0.1.25",
3+
"version": "0.14.28",
44
"scripts": {
55
"ng": "ng",
66
"start": "ng serve",

scripts/generate-site-module.sh

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
#!/bin/bash
2+
3+
# Default directory if not provided
4+
DEFAULT_DIR="@site-modules"
5+
6+
# Check if the module name is provided
7+
if [ -z "$1" ]; then
8+
echo "Usage: $0 <module-name> [dir]"
9+
exit 1
10+
fi
11+
12+
MODULE_NAME=$1
13+
DIR=${2:-$DEFAULT_DIR} # Use second argument or default to @site-modules
14+
15+
echo "Creating module $MODULE_NAME in directory $DIR..."
16+
17+
# Generate the module with routing
18+
ng g m "$DIR/$MODULE_NAME" --routing
19+
20+
# Generate the shell component
21+
ng g c "$DIR/$MODULE_NAME/$MODULE_NAME-shell" --no-standalone
22+
23+
# Generate the service for data-access
24+
ng g s "$DIR/$MODULE_NAME/data-access/$MODULE_NAME"
25+
26+
echo "Module $MODULE_NAME successfully created in $DIR."

0 commit comments

Comments
 (0)