updated readme
This commit is contained in:
31
README.md
31
README.md
@@ -1,25 +1,38 @@
|
||||
# scrapychan
|
||||
|
||||
## Description
|
||||
scrapychan is a go rewrite of a original [scraperchan](https://git.protron.dev/Doc/scraperchan) that i wrote in Python. There was no reason to rewrite the original program but atleast it is faster and i learned some go.
|
||||
scrapychan is a Go rewrite of the original [scraperchan](https://git.protron.dev/Doc/scraperchan) that I wrote in Python. There was no reason to rewrite the original program, but at least it is faster and I learned some Go.
|
||||
|
||||
## Install
|
||||
### Build from source
|
||||
|
||||
### Build from Source
|
||||
#### Dependencies
|
||||
You just need to have [go](https://go.dev/doc/install) installed
|
||||
You just need to have [Go](https://go.dev/doc/install) installed.
|
||||
|
||||
#### Build
|
||||
```
|
||||
```bash
|
||||
git clone https://git.protron.dev/Doc/scrapychan
|
||||
cd scrapychan
|
||||
go build
|
||||
go install
|
||||
```
|
||||
|
||||
### Prebuild binaries
|
||||
or use the binaries provided in the [release section](https://git.protron.dev/Doc/Scrapychan/releases)
|
||||
### Pre-built Binaries
|
||||
Alternatively, use the binaries provided in the [release section](https://git.protron.dev/Doc/Scrapychan/releases)
|
||||
|
||||
## How to use
|
||||
```
|
||||
scrapychan -u=<Thread URL> -o=<Destinationpath of media> -v=<true or false to enable verbose logging>
|
||||
## Example Usage
|
||||
```bash
|
||||
# Download images from a thread to current directory with verbose logging
|
||||
scrapychan -u="https://boards.4chan.org/b/thread/123456789" -v=true
|
||||
|
||||
# Download images from a thread to specific directory
|
||||
scrapychan -u="https://boards.4chan.org/g/thread/987654321" -o="/home/user/4chan_images"
|
||||
```
|
||||
|
||||
## Features
|
||||
- Fast concurrent downloading of images and videos
|
||||
- Support for 4chan's API
|
||||
- Verbose logging option
|
||||
- Cross-platform compatibility
|
||||
- Error handling and recovery
|
||||
- Automatic directory creation
|
||||
Reference in New Issue
Block a user