Skip to content

Commit 6f84f55

Browse files
authored
Create README.md
1 parent 1d9c8df commit 6f84f55

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

README.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ url1 = https://example.com/item1
3535
url2 = https://example.com/item2
3636
```
3737

38-
Before anything, you need to train scraper.
38+
Before anything, you need to train scraper.
3939
The `[WantedList]` section lists the URLs of the items from the `[Scraper]` so that simiar items would be recognised in future. It's like a training data for scraper and it's what you would like to receive if you scraped manually. You can add as many items as you like, using keys numbered from `url1` to `urln`.
4040

4141
```
@@ -50,12 +50,10 @@ The `[File]` section specifies the filename to use for the scraper cache/scrape
5050
bot_token = YOUR_BOT_TOKEN
5151
chat_id = YOUR_CHAT_ID
5252
startup_message = Hello!
53-
5453
```
5554

5655
The `[Telegram]` section specifies the Telegram bot token and chat ID to use for sending notifications. You can obtain a bot token by talking to the BotFather in Telegram. The chat ID can be obtained by sending a message to your bot and inspecting the `chat` object in the JSON response. The `startup_message` key specifies a message to send when the Checker is started.
5756

58-
5957
```
6058
[Time]
6159
startup_delay_sec = 10
@@ -67,7 +65,7 @@ max_error_delay_min = 12
6765

6866
The `[Time]` section specifies the time-related parameters for the Checker. The `startup_delay_sec` key specifies the number of seconds to wait before starting the first scrape. The `min_run_delay_min` and `max_run_delay_min` keys specify the minimum and maximum number of minutes to wait between scrapes. The `min_error_delay_min` and `max_error_delay_min` keys specify the minimum and maximum number of minutes to wait before retrying a scrape in case of an error.
6967

70-
Checker provides onlyn new data using very convinient tinyDB so it wont send same twice to your Telegram.
68+
Checker provides only new data using very convenient tinyDB so it wont send same twice to your Telegram.
7169

7270
## systemd Service
7371

@@ -81,14 +79,12 @@ checker-service --create path/to/config.ini
8179

8280
This will create a new systemd service called `checker.service` that uses the specified configuration file. It will start immediately.
8381

84-
8582
## Debug Logging
8683

8784
If you want to enable debug logging for Checker, you can pass the `--debug` flag when running the `checker` command:
8885

8986
```
9087
checker --debug path/to/config.ini
91-
9288
```
9389

9490
This will output more detailed log messages to specified log file (stated in config.ini)

0 commit comments

Comments
 (0)