farhan7reza7 · farhan7reza7 · Jan 31, 2024 · Jan 31, 2024
diff --git a/README.md b/README.md
@@ -1 +1,272 @@
-added README.md
+if-follow-package
+=================
+
+> `if-follow-package` is a `JavaScript library` that provides APIs for `managing followers and followings on GitHub`. This package allows you to `find users who are not following you back`, `unfollow users who are not following you back`, `find users who are following you back`, `check if a user is following you`, `check if you are following a user`, `get the exact total number of followers`, `get the exact total number of followings`, and other follow control features.
+
+[![NPM Version][npm-image]][npm-url]
+[![npm-build-published][npm-ci-image]][npm-ci-url]
+[![github-build-published][github-image]][github-url]
+[![CI][ci-image]][ci-url]
+[![License][license-image]][licence-url]
+
+Installation
+------------
+
+### Install from `npm registry`
+
+```bash
+
+npm install if-follow-package
+```
+
+### Install from `Github Packages registry`
+
+```bash
+
+npm install @your-username/if-follow-package
+```
+
+Usage
+-----
+
+**Initialize**
+
+```javascript
+//const ifFollow = require('@farhan7reza7/if-follow-package'); or
+
+const ifFollow = require('if-follow-package'); // can use any
+
+```
+
+**Create an instance**
+
+```javascript
+const yourUsername = 'username';  // replace with your username
+const yourToken = 'access-token' // replace with your access token
+
+const followController = ifFollow(yourUsername, yourToken);
+```
+
+##### Steps to generate access-token:
+1. [generate here](https://github.com/settings/tokens/new)
+
+2. Fill Note field:
+
+ <img width="442" alt="image" src="https://github.com/farhan7reza7/if-follow-package/assets/108195448/c38f3677-73b5-448f-9409-36a92a5a134b">
+
+
+3. Check user access:
+
+ <img width="404" alt="image" src="https://github.com/farhan7reza7/if-follow-package/assets/108195448/e5f63553-19c7-41c6-9824-b2557fc618ab">
+
+4. click Generate token
+
+5. Copy token:
+
+ <img width="416" alt="Screenshot 2024-01-31 183401" src="https://github.com/farhan7reza7/if-follow-package/assets/108195448/17184b96-3076-4696-a073-1b3bf352c492">
+
+**Use methods to manage follow**
+
+```javascript
+
+// Get a list of users who are not following you back
+const notFollowingBackList = followController.whoNotFollowingBack();
+
+// Get a list of users who are following you back
+const followingBackList = followController.whoFollowingBack();
+
+// Check if a specific user is following you back
+const isFollowingBackMessage = followController.isFollowingBack('username');
+
+// Unfollow a user who is not following you back followController.unfollowNotFollowingBack('username');
+
+`// Unfollow all users who are not following you back`
+followController.unfollowAllNotFollowingBack();
+
+// Check if a user is following you
+const isFollowerMessage = await followController.isFollower('username');
+
+// Check if you are following a user
+const isFollowingMessage = await followController.isFollowing('username');
+
+// Get the total number of followers
+const totalFollowersMessage = await followController.totalFollowers();
+
+// Get the total number of followings
+const totalFollowingsMessage = await followController.totalFollowings();
+
+```
+
+API Documentation
+-----------------
+
+### `ifFollow`
+
+Represents a module for managing followers and followings on GitHub.
+
+#### Create an instance of `ifFollow`:
+
+```javascript
+
+const followController = ifFollow(yourUsername, yourToken);
+```
+
+*   **`yourUsername`**: Your GitHub username.
+
+*   **`yourToken`**: Your GitHub personal access token.
+
+*   **`Returns:`** An object containing functions to interact with followers and followings on Github.
+
+
+#### Methods:
+
+##### `isFollower(username)`
+
+Check if a user is following you.
+
+```javascript
+
+const isFollowerMessage = followController.isFollower('username');
+
+```
+*   **`username`**: The username of the user you want to check.
+
+*   **`Returns:`** A message indicating if the user is following you.
+
+
+##### `isFollowing(username)`
+
+Check if you are following a user.
+
+```javascript
+
+const isFollowingMessage = followController.isFollowing('username');
+
+```
+
+*   **`username`**: The username of the user you want to check.
+
+*   **`Returns:`** A message indicating if you are following the user.
+
+
+##### `totalFollowers()`
+
+Get the total number of followers.
+
+```javascript
+
+const totalFollowersMessage = followController.totalFollowers();
+```
+
+*   **`Returns:`** A message with the total number of followers.
+
+##### `totalFollowings()`
+
+Get the total number of followings.
+
+```javascript
+
+const totalFollowingsMessage = followController.totalFollowings();
+```
+
+*   **`Returns:`** A message with the total number of followings.
+
+##### `whoNotFollowingBack()`
+
+Get a list of users who are not following you back.
+
+```javascript
+
+const notFollowingBackList = followController.whoNotFollowingBack();
+```
+
+*   **`Returns:`** An array of usernames who are not following you back.
+
+##### `whoFollowingBack()`
+
+Get a list of users who are following you back.
+
+```javascript
+
+const followingBackList = followController.whoFollowingBack();
+```
+
+*   **`Returns:`** An array of usernames who are following you back.
+
+##### `isFollowingBack(username)`
+
+Check if a specific user is following you back.
+
+```javascript
+
+const isFollowingBackMessage = followController.isFollowingBack('username');
+```
+
+*   **`username`**: The username of the user you want to check.
+
+*   **`Returns:`** A message indicating if the user is following you back.
+
+
+##### `unfollowNotFollowingBack(username)`
+
+Unfollow a user who is not following you back.
+
+```javascript
+
+followController.unfollowNotFollowingBack('username');
+```
+*   **`username`**: The username of the user you want to unfollow.
+
+##### `unfollowAllNotFollowingBack()`
+
+Unfollow all users who are not following you back.
+
+```javascript
+
+followController.unfollowAllNotFollowingBack();
+```
+
+For more information, See [`if-follow-package documentation`]()
+
+
+Contributing
+------------
+
+If you find any issues or have suggestions for improvement, please open an issue or create a pull request on the GitHub repository.
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
+
+Best Practices:
+---------------
+
+### The code adheres to recommended practices for readability and maintainability, including:
+
+*   Meaningful variable and function names for clarity.
+*   Clear and concise comments to enhance understanding.
+*   Proper indentation and formatting for visual organization.
+
+License
+-------
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+[See License](https://github.com/farhan7reza7/if-follow-package/blob/main/LICENSE)
+
+History
+-------
+
+For more details about what has changed in each version of this project.  
+[See CHANGELOG.md](CHANGELOG.md).
+
+
+
+[npm-image]: https://img.shields.io/npm/v/if-follow-package
+[npm-url]: https://www.npmjs.com/package/if-follow-package
+[npm-ci-image]: https://github.com/farhan7reza7/if-follow-package/actions/workflows/npm-publish-npm-registry.yml/badge.svg
+[npm-ci-url]: https://github.com/farhan7reza7/if-follow-package/actions/workflows/npm-publish-npm-registry.yml
+[github-image]: https://github.com/farhan7reza7/if-follow-package/actions/workflows/npm-publish-github-packages.yml/badge.svg
+[github-url]: https://github.com/farhan7reza7/if-follow-package/actions/workflows/npm-publish-github-packages.yml
+[ci-image]: https://github.com/farhan7reza7/if-follow-package/actions/workflows/pages/pages-build-deployment/badge.svg
+[ci-url]: https://github.com/farhan7reza7/if-follow-package/actions/workflows/pages/pages-build-deployment
+[license-image]: https://img.shields.io/github/license/farhan7reza7/if-follow-package
+[licence-url]: https://opensource.org/licenses/MIT