revbot.js 0.0.1

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jade
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,133 @@
+# revbot.js
+
+# Note: this package is currently in the early stages of development and testing
+
+`revbot.js` is a Node.js library for building bots on the Revolt platform. It provides an easy-to-use interface for interacting with Revolt's API, managing events, and handling various bot functionalities.
+[revolt server](https://rvlt.gg/7hG9csvW) [docs](https://jade3375.github.io/revbot.js/)
+
+## Installation
+
+```bash
+npm install revbot.js
+```
+
+or
+
+```bash
+yarn add revbot.js
+```
+
+## Basic Setup
+
+Below is an example of how to set up a basic bot using `revbot.js`:
+
+### Example Code
+
+```ts
+import { client } from "revbot.js";
+
+const bot = new client({});
+
+bot.on("ready", () => {
+  console.log("Bot is ready!");
+});
+
+bot.on("message", (message) => {
+  if (message.content === "ping") {
+    message.reply("pong");
+  }
+});
+
+bot.login("YOUR_BOT_TOKEN");
+```
+
+## Features
+
+- Event-based architecture for handling messages, server updates, and more.
+- Easy-to-use managers for channels, servers, users, and roles.
+
+## Development
+
+To contribute or modify the library:
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/Jade3375/revbot.js.git
+   cd revbot.js
+   ```
+
+2. Install dependencies:
+
+   ```bash
+   yarn install
+   ```
+
+3. Build the project:
+
+   ```bash
+   yarn build
+   ```
+
+## Contribution
+
+We welcome contributions to `revbot.js`! To contribute, follow these steps:
+
+1. **Fork the Repository**  
+   Go to the [repository](https://github.com/Jade3375/revbot.js) and click the "Fork" button to create your own copy.
+
+2. **Clone Your Fork**  
+   Clone your forked repository to your local machine:
+
+   ```bash
+   git clone https://github.com/your-username/revbot.js
+   cd revbot.js
+   ```
+
+3. **Create a Branch**  
+   Create a new branch for your feature or bug fix:
+
+   ```bash
+   git checkout -b feature-or-bugfix-name
+   ```
+
+4. **Make Changes**  
+   Implement your changes or fixes in the codebase.
+
+5. **Test Your Changes**  
+   Ensure your changes work as expected by running the project and any relevant tests:
+
+   ```bash
+   yarn test
+   ```
+
+6. **Commit Your Changes**  
+   Commit your changes with a descriptive message:
+
+   ```bash
+   git add .
+   git commit -m "Description of your changes"
+   ```
+
+7. **Push Your Branch**  
+   Push your branch to your forked repository:
+
+   ```bash
+   git push origin feature-or-bugfix-name
+   ```
+
+8. **Open a Pull Request**  
+   Go to the original repository and open a pull request from your branch. Provide a clear description of your changes and why they should be merged.
+
+### Guidelines
+
+- Follow the existing code style and structure.
+- Write clear and concise commit messages.
+- Add or update documentation if necessary.
+- Ensure your changes do not break existing functionality.
+
+Thank you for contributing to `revbot.js`!
+
+## License
+
+This project is licensed under the MIT License.