Skip to content

Commit 081833c

Browse files
authored
Update README.md
1 parent bf1e315 commit 081833c

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Feel free to report problems or suggest features, though as a disclaimer,
1111
_I may not have the bandwidth or interest to tackle all reported issues_.
1212
PRs are always welcome, though!
1313

14-
## Usage
14+
## Installation/Usage
1515

1616
### From PyPI
1717

@@ -107,7 +107,7 @@ From [Releases](https://github.com/Pyreko/yt-community-post-archiver/releases),
107107
yt-community-post-archiver --help
108108
```
109109

110-
### Examples
110+
## Examples
111111

112112
For example, let's say I run:
113113
@@ -147,19 +147,19 @@ At the time of writing, this gives me two files that look like this - `post.json
147147
and an image file called `UgkxzjFK9MbmdHoUW7Tyg54ncKqzkQxAb1AN-0.jpg`, containing the included image. Note that some
148148
details may change throughout the versions; this document will be updated to reflect that though.
149149
150-
#### Set save location
150+
### Set save location
151151
152152
If you want to set the save location, then use `-o`:
153153
154154
```shell
155155
yt-community-post-archiver "https://www.youtube.com/@IRyS/posts" -o "/home/me/my_save"
156156
```
157157
158-
#### Logging in
158+
### Logging in
159159
160160
You may want to provide a logged-in instance to this tool as this is the only way to get membership posts or certain details like poll vote percentages. The tool supports a few methods.
161161
162-
##### Using a browser profile
162+
#### Using a browser profile
163163
164164
I've found this way works a bit better from personal experience. You can re-use an existing browser profile that is
165165
logged into your YouTube account to grab membership posts with the `-p` flag, where the path is where your user
@@ -172,7 +172,7 @@ yt-community-post-archiver -o output/ -p ~/.config/chromium/ "https://www.youtu
172172
By default this will use the default profile name; if you need to override this then use `-n` as well. **I highly recommend
173173
creating a new profile for using this tool (whether it's Chrome or Firefox) just so it doesn't accidentally delete some tabs or something**.
174174

175-
##### Using a cookies file
175+
#### Using a cookies file
176176

177177
Another method is if you have a Netscape-format cookies file, which you can pass the path with `-c` / `--cookies`:
178178

@@ -187,7 +187,7 @@ You can see how to get a cookies file by following [the instructions on how to d
187187
Also note that when using this from WSL, avoid reusing a Windows Chrome profile path (`/mnt/c/.../User Data`) with `-p`. Linux Chrome/Chromium in WSL does not reliably read/decrypt Windows profile data. Use a Linux profile directory
188188
instead (for example `~/.config/google-chrome`) or use a cookie file.
189189

190-
##### Using remote debugging to connect to a running instance
190+
#### Using remote debugging to connect to a running instance
191191

192192
You can also start Chrome/Chromium with a remote debugging port, and connect this program to it. For example:
193193

@@ -203,15 +203,15 @@ You can also start Chrome/Chromium with a remote debugging port, and connect thi
203203
yt-community-post-archiver "https://www.youtube.com/@kaminariclara/posts" -o "output" --remote-debugging-port 9222
204204
```
205205

206-
#### Use Firefox instead of Chrome as the driver
206+
### Use Firefox instead of Chrome as the driver
207207

208208
The default driver is Chrome, but Firefox should work as well.
209209

210210
```shell
211211
yt-community-post-archiver "https://www.youtube.com/@PomuRainpuff/posts" -d "firefox"
212212
```
213213

214-
## Other
214+
## Other Information
215215

216216
### Polls
217217

0 commit comments

Comments
 (0)