diff --git a/.github/CHANGES.md b/.github/CHANGES.md deleted file mode 100644 index 8373a4f..0000000 --- a/.github/CHANGES.md +++ /dev/null @@ -1,9 +0,0 @@ -# Changes - -```diff -- removing unused depencies - -+ fix known security major -+ added update notifier -+ added error handling -``` \ No newline at end of file diff --git a/.github/SECURITY.md b/.github/SECURITY.md deleted file mode 100644 index 10be8e5..0000000 --- a/.github/SECURITY.md +++ /dev/null @@ -1,14 +0,0 @@ -# Security Policy - -## Supported Versions -discord.js v14 -| Version | Recommended | -| ------- | ------------------ | -| 1.4.8 | :white_check_mark: | -| < 1.4.8 | :x: | - -## Reporting a Vulnerability -under v1.4.8 theres some security issues, if you using discord-afk-js under version 1.4.8. please update it to latest version -``` -npm i discord-afk-js@latest -``` diff --git a/README.md b/README.md index bcd418d..0329f63 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,15 @@ # discord-afk-js + **[discord-afk-js](https://www.npmjs.com/package/discord-afk-js?activeTab=readme)** is a JavaScript library created to facilitate the management of AFK (Away From Keyboard) status within Discord bots. This library is designed to simplify the process of tracking and handling AFK users in a Discord server without the need for an external database. # Requirements -- [NodeJS](https://nodejs.org) 16.9.0 or higher + +- [NodeJS](https://nodejs.org) 18.x or higher # Installation + To start using **discord-afk-js**, you can install it through npm, the Node.js package manager. Open your terminal and run the following command: ```bash @@ -30,59 +33,17 @@ npm install discord-afk-js ``` # Usage -**discord-afk-js** offers a straightforward way to manage AFK users in your Discord bot. Below is an example of how to utilize the **AfkClient** class: - -```javascript -const { AfkClient } = require('discord-afk-js'); -const moment = require('moment'); - -// Create an instance of AfkClient -const afk = new AfkClient(); - -// Checking if a user is AFK without time -const reason = args.join(' ') || 'No Reason'; -afk.addUser('user123', reason); - -if (afk.findUser('user123')) { - console.log('User is marked as AFK'); // console: User is marked as AFK - console.log('AFK Message:', afk.afkMessage('user123')); // console: AFK Message: No Reason -} -// or -// Adding a user to AFK status with time -const reason = args.join(' ') || 'No Reason'; -afk.addUser('user123', [Date.now(), reason]); - -if (afk.findUser('user123')) { - console.log('User is marked as AFK'); // console: User is marked as AFK - const data = afk.findMessage('user123'); - const [ time, reason ] = data; - const timeago = moment(time).fromNow(); +[No Database Version](https://github.com/SITCommunity/discord-afk-js/tree/nodb-stable?tab=readme-ov-file) - console.log('AFK Message:', `${reason} ${timeago}`); // console: AFK Message: No Reason a few seconds ago -} - -// Removing a user from AFK status -afk.removeUser('user123'); -``` -In the code snippet above, we start by importing the **AfkClient** class. After creating an instance of this class, we demonstrate how to add a user to the AFK list, check their AFK status, and remove them from AFK status. - -# API -The **discord-afk-js** library provides a set of methods for working with AFK status using the **AfkClient** class. - -# Changelog | Migrating to discord-afk-js -```diff -+ change afk to AfkClient for import -+ afk.set() -> afk.addUser() -+ afk.delete() -> afk.removeUser() -+ afk.get() -> afk.findUser() -+ afk.findMessage() -``` +[Database Version](https://github.com/SITCommunity/discord-afk-js/tree/db-stable?tab=readme-ov-file) # License -This project is open-source and is licensed under the Apache-2.0. You can find more details about the license in the [LICENSE.md](https://github.com/CyraTeam/discord-afk-js/blob/main/LICENSE) file included in the project. + +This project is open-source and is licensed under MIT License. You can find more details about the license in the [LICENSE.md](https://github.com/CyraTeam/discord-afk-js/blob/main/LICENSE) file included in the project. With this comprehensive readme, you have a clear and detailed guide on how to use the **discord-afk-js** library to manage AFK status in your Discord bot. # Discord Servers - Discord + +Discord