Skip to content

Commit

Permalink
feat: restruncture of files + readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Nomekuma committed Oct 14, 2023
1 parent 218d442 commit 00cd334
Show file tree
Hide file tree
Showing 10 changed files with 654 additions and 500 deletions.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Nomekuma

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.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Kuma-Lite

## Introduction

Kuma-Lite is a Discord bot that provides anime and manga recommendations, as well as a ranking of server members based on their time in the server.

## Features

- `/randomanime`: Provides a random anime recommendation.
- `/randommanga`: Provides a random manga recommendation.
- `/searchanime`: Search for a specific anime by name.
- `/searchmanga`: Search for a specific manga by name.
- `/rank`: Displays a ranking of server members based on their time in the server.
- `/help`: Displays a list of available commands.

## Setup

1. Clone this repository.
2. Create a `.env` file in the project root and add the following variables:

```js
CLIENT_ID=your_discord_bot_client_id
TOKEN=your_discord_bot_token
```

3. Install the project dependencies:
```
npm install
```
4. Run the bot:
```
npm start
```

## Dependencies

- [discord.js](https://discord.js.org/): Discord API library for Node.js.

- [axios](https://axios-http.com/): Promise-based HTTP client for making requests.

- [dotenv](https://www.npmjs.com/package/dotenv): Loads environment variables from a `env` file.

## Usage

1. Add the bot to your Discord server by visiting the following link: https://discord.com/api/oauth2/authorize?client_id=1162683498042236968&permissions=8&scope=bot
2. Type `/help` in any channel to see a list of available commands.

## License

This project is licensed under the [MIT License](LICENSE).

## Acknowledgments

- Thanks to the creators of Discord.js for providing an excellent library for Discord bot development.

Loading

0 comments on commit 00cd334

Please sign in to comment.