From 556a5e9d006955be5db39430e81e6f43be525ef9 Mon Sep 17 00:00:00 2001 From: NekoMonci12 Date: Tue, 3 Jun 2025 21:25:58 +0700 Subject: [PATCH] ReadMe.md update --- LICENSE | 21 +++++++++++++++++++++ README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 75 insertions(+), 2 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..841b1a6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 NekoMonci12 + +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. diff --git a/README.md b/README.md index d8a6042..b154e9f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,54 @@ -# RakunNakun-AI - +
+ YueMi Logo +
+ +--- +## 📃 Description +``` +RakunNakun is an Discord Bot that integrate LLM into chat on discord. +``` + +--- +## 🔧 Dependencies +- MySQL Logo MySQL Database +- MongoDB Logo MongoDB Database +- NodeJS Logo NodeJS 21 + +--- +## ⚙️ Installation +1. Copy `.env.example` to `.env` +2. Fill Credentials on `.env` +3. Run This Commands +```bash +npm install +node index.js +``` + +--- +## 🚧 Features +- MongoDB Logo Caching System + - Voyage Logo [Text Embedding](https://www.voyageai.com/) +- LLM API Compability + - OpenAI Logo [OpenAI](https://openai.com/) + - Deepseek Logo [Deepseek](https://chat.deepseek.com/) + - LLM7 Logo [LLM7](https://llm7.io/) +- Guilds Tokens +- API Endpoint + +--- +## 📲 Pregenerate (Using [LLM7](https://llm7.io/)) +``` +npm install +node batchpull.js +``` + +--- +## 🎥 Preview +### `/chat` - Chat with LLM Models + + +### `/debugmode` - Toggle Debug Mode + + +### `/generate-api` - API Endpoint System +