Merge remote-tracking branch 'refs/remotes/origin/main'

Author: KevinTrinh1227

README.md

@@ -1,2 +1,72 @@
-# Github-Auto-Followers-Bot
-A async Github program that automatically follows and unfollows users, to generate/boost your profile growth, presence, and interactions. 
+<div align="center">
+  <h1>
+    Github-Followers-Bot
+  </h1>
+</div>
+<p align="center">
+  A Github Bot that automatically follows and unfollows users, to boost your profile growth, presence, and interactions.
+</p>
+
+<div align="center">
+  <img src="https://img.shields.io/badge/maintenance-experimental-blue.svg" alt="Maintained status" />
+  <img src="https://img.shields.io/github/v/release/KevinTrinh1227/Github-Followers-Bot.svg" alt="Release badge" />
+</div>
+
+## 📌 Important Info (Please Read)
+This project is **experimental** and was developed for **educational purposes** only. Please be aware that using automated tools on GitHub, including this application, may violate GitHub’s [Terms of Service](https://docs.github.com/en/site-policy/acceptable-use-policies/github-acceptable-use-policies#4-spam-and-inauthentic-activity-on-github), which prohibit activities such as:
+* Automated excessive bulk activity (e.g., mass following or starring)
+* Coordinated inauthentic interactions, such as fake accounts or bots
+* Rank abuse through automated following or starring
+* Spamming or cryptocurrency mining
+* Excessive burden on GitHub servers through automated requests
+  
+**By using this tool, you acknowledge the risk** of your account being flagged or banned for violating GitHub's policies. Proceed with caution, and use at your own risk. This tool is intended solely for learning purposes, and the developer is not responsible for any misuse or potential consequences.
+
+## 👥 What is this project?
+This project is a Node.js application that automates following and unfollowing users on GitHub at random intervals, simulating human-like behavior. It uses a queue system to manage actions, integrates logging for tracking activity, ensures compliance with GitHub’s API rate limits, and helps boost your profile growth, presence, and interactions by automatically engaging with users. Designed for long-term, 24/7 operation, it efficiently handles large volumes of users by optimizing API calls and minimizing redundant actions, ensuring smooth and resource-effective performance.
+
+This project was built using Node 16.20.2 on Ubuntu (Linux)
+
+## 🛠 Installation & setup
+
+1. Clone repository OR download the [latest release](https://github.com/KevinTrinh1227/Github-Auto-Followers-Bot/releases)
+
+   ```sh
+   git clone https://github.com/KevinTrinh1227/Github-Followers-Bot
+   ```
+
+   ```sh
+   cd Github-Auto-Followers-Bot
+   ```
+
+2. **OPTIONAL**: Use the correct Node version using [NVM](https://github.com/nvm-sh/nvm) (Node v16.20.2)
+
+   ```sh
+   nvm install 16
+   ```
+
+   ```sh
+   nvm alias default 16
+   ```
+
+3. Install the dependencies using npm or yarn
+
+   ```sh
+   npm install
+   ```
+
+   ```sh
+   yarn install
+   ```
+
+## 🚀 Start the application
+
+1. Now run the application
+
+   ```sh
+   npm start
+   ```
+
+   ```sh
+   yarn run start
+   ```