diff --git a/README.md b/README.md index 2b9ee11..8b42658 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,49 @@ -# hamsterBOT -simple autiTap bot for https://t.me/hamster_kombat_bot - -## run@linux -``` -git clone git@github.com:maanimis/hamsterBOT.git -cd hamsterBOT -``` -edit 'Authorization' header from index.js and save it: -``` -nano index.js -``` -install dependencies: -``` -npm i -``` - -run: -``` -npm start -``` - - -![alt text](images/1.jpg) +# HamsterBOT + +## Overview + +HamsterBOT is a bot designed to automate specific tasks using hamster accounts. This readme will guide you through the steps to install Node.js, clone the repository, install the necessary dependencies, configure the bot, and run it. + +## Prerequisites + +Before you start, ensure you have the following installed on your machine: + +- [Git](https://git-scm.com/) +- [Node.js](https://nodejs.org/) + +## Installation Guide + +### Step 1: Install Node.js +install from from the [official website](https://nodejs.org/). + + +### Step 2: Clone the Repository + +1. Open your terminal or command prompt. +2. Clone the repository using the SSH link: + ```bash + git clone git@github.com:maanimis/hamsterBOT.git +3. Change directory to the cloned repository: + ```bash + cd hamsterBOT + + +### Step 3: Install Dependencies + +Install the required dependencies by running: + ```npm install``` + + +### Step 4: Edit Configuration + +1. Open the `config/production.json` file in a text editor. +2. Edit the configuration settings as needed. For example, you might need to update API keys, account information, and other settings relevant to your environment. + +### Step 5: Run the Bot + +Start the bot by running: + ```npm start``` + + + +![alt text](images/1.png) diff --git a/images/1.jpg b/images/1.jpg deleted file mode 100644 index fba4e52..0000000 Binary files a/images/1.jpg and /dev/null differ diff --git a/images/1.png b/images/1.png new file mode 100644 index 0000000..36ea33f Binary files /dev/null and b/images/1.png differ