Skip to content

Commit

Permalink
📝 Add some initial docs
Browse files Browse the repository at this point in the history
  • Loading branch information
eigenein committed Nov 7, 2024
1 parent 6b17144 commit 5b12e38
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ categories = ["command-line-utilities"]
description = "Marktplaats search notifications in Telegram (unofficial)"
edition = "2021"
keywords = ["marktplaats", "telegram"]
license-file = "LICENSE"
license = "MIT"
publish = true
readme = "README.md"
repository = "https://github.com/eigenein/mrktpltsbot"
Expand Down
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,38 @@ Self-hosted Marktplaats notifications for Telegram
](https://app.codecov.io/gh/eigenein/mrktpltsbot)

> [!CAUTION]
> This is an **unofficial** bot that **uses unofficial APIs**,
> This is an **unofficial bot** that **uses unofficial APIs**,
> so you take all the responsibility for any consequences of running the bot,
> for example, account or IP bans.
> [!WARNING]
> The version `2.x` is not well-tested yet.
> [!NOTE]
> I realize the documentation is not complete – this is not a deliberate choice,
> but rather the best I could do given the limited resources.
> I strive to maintain and improve it over time.
## Installation

`mrktpltsbot` is a single binary which can be installed from [crates.io](https://crates.io/crates/mrktpltsbot):

```shell
cargo install mrktpltsbot
```

## Running
## Configuration

`mrktpltsbot` supports conventional CLI options as well as environment variables.
On launch, it also automatically loads `.env` from the working directory.

> [!NOTE]
> TODO
See `mrktpltsbot --help` for the complete list of options,
including the corresponding environment variable names.

## Configuration
> [!TIP]
> Right now, the only required option is a
> [Telegram bot token](https://core.telegram.org/bots/api#authorizing-your-bot).
> [!NOTE]
> TODO
> [!IMPORTANT]
> `mrktpltsbot` stores all the data in an SQLite database.
> By default, it creates the database file in the working directory.

0 comments on commit 5b12e38

Please sign in to comment.