diff --git a/README.md b/README.md index d4d3a23..bd7e522 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,10 @@ A PHP-based Telegram tip bot for the Salvium (Monero fork) cryptocurrency. ## Installation 1. Clone the repo -2. Update `config.php` with your RPC, DB, and Telegram Bot credentials -3. Run `salvium_tipbot.php` as a Telegram webhook listener -4. Schedule `salvium_tipbot_monitor.php` using `cron` for periodic checks +2. Copy `config.sample.php` to `config.php` and fill in your credentials +3. Update `config.php` with your RPC, DB, and Telegram Bot credentials +4. Run `salvium_tipbot.php` as a Telegram webhook listener +5. Schedule `salvium_tipbot_monitor.php` using `cron` for periodic checks ## Requirements - PHP 8.1+ diff --git a/config.sample.php b/config.sample.php new file mode 100644 index 0000000..ef7f5ee --- /dev/null +++ b/config.sample.php @@ -0,0 +1,15 @@ + '127.0.0.1', + 'SALVIUM_RPC_PORT' => 28881, + 'SALVIUM_RPC_USERNAME' => 'rpcuser', + 'SALVIUM_RPC_PASSWORD' => 'rpcpassword', + + 'DB_HOST' => 'localhost', + 'DB_NAME' => 'salvium_tipbot', + 'DB_USER' => 'your_db_user', + 'DB_PASS' => 'your_db_pass', + 'DB_CHARSET' => 'utf8mb4', + + 'TELEGRAM_BOT_TOKEN' => 'YOUR_TELEGRAM_BOT_TOKEN_HERE', +];