Skip to content

Commit f2e5a3e

Browse files
committed
Improve README: enhance clarity, add donations section, and refine documentation
- Improved disclaimer and important notice sections for better professionalism - Added Quick Start section for easier onboarding - Added Support This Project section with KenTom donations link - Fixed installation steps with better formatting and structure - Reorganized deprecated features section with clearer explanation - Enhanced legal disclaimer with comprehensive warnings - Fixed typo: "How It Should Work Works" → "How It Works" - Updated table of contents to include all sections - Improved overall readability and consistency throughout the document
1 parent 6e41967 commit f2e5a3e

File tree

1 file changed

+79
-38
lines changed

1 file changed

+79
-38
lines changed

ReadMe.md

Lines changed: 79 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,45 @@
11
# Aviator Betting Bot
22

3-
## ⚠️ Disclaimer
3+
## ⚠️ Important Notice
44

5-
Please dont message me requesting me to create a bot for free or requesting me to help you configure the bot, Im am normally very busy and I made this opensource for you guys to help me develop it, not me to help you!!
5+
Please note: This project is open source and intended for community collaboration. I'm unable to provide free bot creation services or individual configuration support due to time constraints. This repository is meant for developers to contribute and learn together.
66

77
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
88
[![Node.js Version](https://img.shields.io/badge/node-%3E%3D%2014.0.0-brightgreen.svg)](https://nodejs.org/)
99
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/yourusername/aviator-bot/issues)
1010

1111
An intelligent automation tool for the Aviator game, leveraging Node.js, Puppeteer, and advanced betting strategies. This bot automates the betting process while implementing smart risk management and real-time analytics.
1212

13+
## 🚀 Quick Start
14+
15+
```bash
16+
# Clone the repository
17+
git clone https://github.com/Raccoon254/Aviator-Automated-Betika-Bot.git aviator-bot
18+
cd aviator-bot
19+
20+
# Install dependencies
21+
npm install
22+
23+
# Run the bot
24+
npm run start
25+
```
26+
1327
## Table of Contents
1428

15-
- [Features](#-features)
16-
- [Requirements](#-requirements)
17-
- [Installation](#-installation)
18-
- [Configuration](#-configuration)
19-
- [Usage](#-usage)
20-
- [How It Works](#-how-it-works)
21-
- [Architecture](#-architecture)
22-
- [Strategies](#-strategies)
29+
- [Features](#features)
30+
- [Requirements](#requirements)
31+
- [Installation](#installation)
32+
- [Configuration](#configuration)
33+
- [How It Works](#how-it-works)
34+
- [Architecture](#architecture)
35+
- [Strategies](#strategies)
36+
- [Deprecated Features](#deprecated-support-for-major-betting-sites-like-betika)
37+
- [Future Enhancements](#future-enhancements)
38+
- [FAQ](#faq)
2339
- [Contributing](#-contributing)
24-
- [Future Enhancements](#-future-enhancements)
25-
- [FAQ](#-faq)
40+
- [Support This Project](#-support-this-project)
2641
- [Disclaimer](#-disclaimer)
42+
- [License](#license)
2743

2844
## Features
2945

@@ -53,31 +69,35 @@ An intelligent automation tool for the Aviator game, leveraging Node.js, Puppete
5369

5470
## Installation
5571

56-
1. Clone the repository:
57-
```bash
58-
git clone https://github.com/Raccoon254/Aviator-Automated-Betika-Bot.git aviator-bot
59-
cd aviator-bot
60-
```
72+
1. **Clone the repository:**
73+
```bash
74+
git clone https://github.com/Raccoon254/Aviator-Automated-Betika-Bot.git aviator-bot
75+
cd aviator-bot
76+
```
6177

62-
2. Install dependencies:
63-
```bash
64-
npm install
65-
```
78+
2. **Install dependencies:**
79+
```bash
80+
npm install
81+
```
82+
83+
3. **Run the bot:**
6684

67-
## You can test the bot on the live site
85+
You can test the bot on the live demo site:
6886
```bash
6987
npm run start
7088
```
71-
Or
89+
90+
Or alternatively:
7291
```bash
7392
node index.js
7493
```
75-
If you wish to make modification proceed to the next step
7694

77-
3. Set up configuration:
78-
```md
79-
# Edit config.js with your preferred settings
80-
```
95+
4. **Configure (Optional):**
96+
97+
If you wish to make modifications, edit the configuration file:
98+
```bash
99+
# Edit util/config.js with your preferred settings
100+
```
81101

82102
## Configuration
83103

@@ -223,16 +243,18 @@ const customStrategy = {
223243
};
224244
```
225245

226-
## Deprecated Support for major betting sites like betika
227-
- I removed configuration to test on live sites
228-
- If you need the configuration for that you can message me, I will try to help
229-
- I will try to add support for major betting sites in the future
246+
## Deprecated Support for Major Betting Sites Like Betika
247+
248+
**Note**: The following features have been temporarily removed from the current version:
249+
250+
- **Live betting site integration** - Configuration for major betting sites (Betika, etc.) has been removed
251+
- **Database integration** - MySQL database features are currently disabled
252+
- **Web interface** - The monitoring dashboard is temporarily unavailable
253+
- **Statistical analysis tools** - Predictive analytics features are under development
230254

231-
- removed the database integration for now, I will try to add it in the future
232-
- removed the web interface for now, I will try to add it in the future
233-
- removed the statistical analysis tools and prediction for now, I will try to add it in the future
255+
These features are planned for re-implementation in future releases. If you need access to legacy configurations, please open an issue on GitHub.
234256

235-
## How It Should Work Works
257+
## How It Works
236258
The bot operates in a series of steps as outlined below:
237259

238260
1. **Authentication**: Logs into the betting site using provided credentials.
@@ -273,9 +295,20 @@ A: No. This is a tool for automation and should be used responsibly with proper
273295
**Q: How do I handle errors?**
274296
A: Check the `logs/error.log` file for detailed error information. Most common issues are related to network connectivity or selector changes.
275297

276-
## ⚠️ Disclaimer
298+
## ⚠️ Legal Disclaimer
299+
300+
**IMPORTANT - PLEASE READ CAREFULLY:**
301+
302+
This software is provided for **educational and research purposes only**. By using this bot, you acknowledge and agree to the following:
303+
304+
- **Financial Risk**: Gambling involves substantial financial risk. Never bet money you cannot afford to lose.
305+
- **No Guarantees**: This bot does not guarantee profits. Past performance does not indicate future results.
306+
- **Legal Compliance**: Users are solely responsible for ensuring their use of this software complies with local laws and regulations.
307+
- **Terms of Service**: Using automated bots may violate the terms of service of betting platforms. Use at your own risk.
308+
- **No Liability**: The developers and contributors are not responsible for any financial losses, legal issues, or other damages resulting from the use of this software.
309+
- **Age Restriction**: You must be of legal gambling age in your jurisdiction to use this software.
277310

278-
This bot is for educational purposes only. Gambling involves risk and you should never bet more than you can afford to lose. The developers are not responsible for any financial losses incurred through the use of this software.
311+
**USE THIS SOFTWARE AT YOUR OWN RISK.**
279312

280313
## License
281314

@@ -285,5 +318,13 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
285318

286319
Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
287320

321+
## 💝 Support This Project
322+
323+
If you find this project helpful and would like to support its development, consider making a donation:
324+
325+
**[Donate via KenTom](https://www.kentom.co.ke/donate)**
326+
327+
Your support helps maintain and improve this project. Every contribution, no matter the size, is greatly appreciated!
328+
288329
---
289330
Made with ❤️ by [Raccoon254](https://www.kentom.co.ke/)

0 commit comments

Comments
 (0)