Skip to content

Commit 4909886

Browse files
committed
docs: readme
1 parent d01caff commit 4909886

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed

LICENSE

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

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,25 @@
11
# Yu-Gi-Oh! Ruling AI Chatbot
2+
3+
[![Documentation](https://img.shields.io/badge/Documentation-Link-blue)](https://nedhmn.github.io/ygo-ruling-ai-chatbot/)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
5+
6+
A monorepo for a Yu-Gi-Oh! ruling AI chatbot focused on Goat Format, built with Turborepo. It leverages AI RAG with OpenAI embeddings and Pinecone for specialized context.
7+
8+
<div align="center" style="margin-bottom: 20px">
9+
<img src="./assets/preview.gif" alt="ygo-ruling-ai-chatbot-preview">
10+
</div>
11+
12+
## ✨ Features
13+
14+
- **AI RAG**: Uses Retrieval Augmented Generation with OpenAI embeddings and Pinecone for accurate ruling context.
15+
- **Goat Format Specialized**: Trained and focused on Yu-Gi-Oh! Goat Format rulings.
16+
- **Data Seeding**: Includes a seeder package to populate the vector database.
17+
- **Monorepo Structure**: Managed efficiently with Turborepo.
18+
19+
## 🚀 Getting Started
20+
21+
Coming Soon...
22+
23+
## 📄 License
24+
25+
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.

assets/preview.gif

508 KB
Loading

0 commit comments

Comments
 (0)