feat : add readme and example env

.env.example

@@ -0,0 +1,3 @@
+HUGGINGFACE_TOKEN=your-secret-key
+DATABASE_URL=your-database-url
+SECRET_KEY=your-secret-key

README.md

@@ -1,13 +1,71 @@
+Berikut adalah contoh README yang dapat digunakan untuk proyek ChatSQL:
+
 ---
-title: Chatsql
-emoji: 🔥
-colorFrom: purple
-colorTo: green
-sdk: gradio
-sdk_version: 5.13.2
-app_file: app.py
-pinned: false
-short_description: This chatbot can access your database directly
+
+# ChatSQL
+
+ChatSQL adalah aplikasi chatbot yang dapat berinteraksi langsung dengan basis data Anda. Dengan menggunakan antarmuka percakapan, ChatSQL memungkinkan pengguna untuk mengajukan pertanyaan dalam bahasa alami dan mendapatkan jawaban langsung dari basis data tanpa perlu menulis kueri SQL secara manual.
+
+## Fitur
+
+- **Interaksi Bahasa Alami**: Ajukan pertanyaan dalam bahasa sehari-hari tanpa perlu memahami sintaks SQL.
+- **Akses Basis Data Langsung**: Chatbot dapat mengakses dan mengambil data langsung dari basis data Anda.
+- **Antarmuka Pengguna Interaktif**: Dilengkapi dengan antarmuka berbasis web yang ramah pengguna menggunakan Gradio.
+
+## Instalasi
+
+1. **Kloning repositori ini**:
+
+   ```bash
+   git clone https://github.com/Alfthrpy/chatsql.git
+   cd chatsql
+   ```
+
+2. **Buat dan aktifkan lingkungan virtual**:
+
+   ```bash
+   python -m venv env
+   source env/bin/activate  # Untuk Windows, gunakan 'env\Scripts\activate'
+   ```
+
+3. **Instal dependensi**:
+
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+## Konfigurasi
+
+1. **Pengaturan Basis Data**: Pastikan Anda memiliki basis data yang dapat diakses oleh ChatSQL. Perbarui parameter koneksi basis data sesuai kebutuhan Anda di file konfigurasi atau langsung dalam kode.
+
+2. **Kunci API Huggingface**: Jika Anda menggunakan model bahasa dari Huggingface untuk pemrosesan bahasa alami, pastikan untuk menyertakan kunci API Anda dalam file konfigurasi atau sebagai variabel lingkungan.
+
+## Penggunaan
+
+1. **Jalankan aplikasi**:
+
+   ```bash
+   python app.py
+   ```
+
+2. **Akses antarmuka pengguna**: Buka browser Anda dan navigasikan ke URL yang ditampilkan di terminal (biasanya `http://127.0.0.1:7860/`).
+
+3. **Mulai berinteraksi**: Gunakan antarmuka untuk mengajukan pertanyaan dalam bahasa alami dan dapatkan jawaban langsung dari basis data Anda.
+
+## Struktur Proyek
+
+- `app.py`: Skrip utama untuk menjalankan aplikasi Gradio.
+- `agents.py`: Berisi agen atau logika untuk memproses input pengguna dan berinteraksi dengan basis data.
+- `requirements.txt`: Daftar dependensi Python yang diperlukan untuk menjalankan aplikasi.
+
+## Kontribusi
+
+Kontribusi sangat diterima! Silakan fork repositori ini dan ajukan pull request untuk perbaikan atau fitur baru.
+
+## Lisensi
+
+Proyek ini dilisensikan di bawah lisensi MIT.
+
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+Catatan: Pastikan untuk mengganti bagian konfigurasi dengan detail spesifik sesuai dengan kebutuhan dan lingkungan Anda.