feat: update README files to include usage instructions

- Added a new section on how to use SurfSense across all language-specific README files. - Included visual elements such as images and badges for better user engagement and clarity. - Enhanced the structure of the documentation to improve readability and accessibility for users.
2026-04-25 00:36:31 +02:00 · 2026-02-16 05:05:30 -08:00 · 2026-02-16 05:05:30 -08:00 · 9e359a79b9
commit 9e359a79b9
parent 9390f195cc
5 changed files with 443 additions and 898 deletions
--- a/README.hi.md
+++ b/README.hi.md
@ -15,6 +15,9 @@

 [English](README.md) | [Español](README.es.md) | [Português](README.pt-BR.md) | [हिन्दी](README.hi.md) | [简体中文](README.zh-CN.md)

+</div>
+<div align="center">
+<a href="https://trendshift.io/repositories/13606" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13606" alt="MODSetter%2FSurfSense | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
 </div>

 # SurfSense
@ -22,101 +25,98 @@

 SurfSense एक अत्यधिक अनुकूलन योग्य AI शोध एजेंट है, जो बाहरी स्रोतों से जुड़ा है जैसे सर्च इंजन (SearxNG, Tavily, LinkUp), Google Drive, Slack, Microsoft Teams, Linear, Jira, ClickUp, Confluence, BookStack, Gmail, Notion, YouTube, GitHub, Discord, Airtable, Google Calendar, Luma, Circleback, Elasticsearch, Obsidian और भी बहुत कुछ आने वाला है।

-<div align="center">
-<a href="https://trendshift.io/repositories/13606" target="_blank"><img src="https://trendshift.io/api/badge/repositories/13606" alt="MODSetter%2FSurfSense | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
-</div>


-# वीडियो
+# वीडियो 

 https://github.com/user-attachments/assets/cc0c84d3-1f2f-4f7a-b519-2ecce22310b1

-
 ## पॉडकास्ट नमूना

 https://github.com/user-attachments/assets/a0a16566-6967-4374-ac51-9b3e07fbecd7


+## SurfSense का उपयोग कैसे करें

+### Cloud
+
+1. [surfsense.com](https://www.surfsense.com) पर जाएं और लॉगिन करें।
+
+<p align="center"><img src="https://github.com/user-attachments/assets/b4df25fe-db5a-43c2-9462-b75cf7f1b707" alt="लॉगिन" /></p>
+
+2. अपने कनेक्टर जोड़ें और सिंक करें। कनेक्टर्स को अपडेट रखने के लिए आवधिक सिंकिंग सक्षम करें।
+
+<p align="center"><img src="https://github.com/user-attachments/assets/59da61d7-da05-4576-b7c0-dbc09f5985e8" alt="कनेक्टर्स" /></p>
+
+3. जब तक कनेक्टर्स का डेटा इंडेक्स हो रहा है, दस्तावेज़ अपलोड करें।
+
+<p align="center"><img src="https://github.com/user-attachments/assets/d1e8b2e2-9eac-41d8-bdc0-f0cdc405d128" alt="दस्तावेज़ अपलोड करें" /></p>
+
+4. सब कुछ इंडेक्स हो जाने के बाद, कुछ भी पूछें (उपयोग के मामले):
+
+   - बेसिक सर्च और उद्धरण
+
+   <p align="center"><img src="https://github.com/user-attachments/assets/81e797a1-e01a-4003-8e60-0a0b3a9789df" alt="सर्च और उद्धरण" /></p>
+
+   - दस्तावेज़ मेंशन QNA
+
+   <p align="center"><img src="https://github.com/user-attachments/assets/be958295-0a8c-4707-998c-9fe1f1c007be" alt="दस्तावेज़ मेंशन QNA" /></p>
+
+   - रिपोर्ट जनरेशन और एक्सपोर्ट (फ़िलहाल PDF, DOCX)
+
+   <p align="center"><img src="https://github.com/user-attachments/assets/9836b7d6-57c9-4951-b61c-68202c9b6ace" alt="रिपोर्ट जनरेशन" /></p>
+
+   - पॉडकास्ट जनरेशन
+
+   <p align="center"><img src="https://github.com/user-attachments/assets/58c9b057-8848-4e81-aaba-d2c617985d8c" alt="पॉडकास्ट जनरेशन" /></p>
+
+   - इमेज जनरेशन
+
+   <p align="center"><img src="https://github.com/user-attachments/assets/25f94cb3-18f8-4854-afd9-27b7bfd079cb" alt="इमेज जनरेशन" /></p>
+
+
+### सेल्फ-होस्टेड
+
+पूर्ण डेटा नियंत्रण और गोपनीयता के लिए SurfSense को अपने स्वयं के बुनियादी ढांचे पर चलाएं।
+
+**त्वरित शुरुआत (Docker एक कमांड में):**
+
+```bash
+docker run -d -p 3000:3000 -p 8000:8000 -p 5133:5133 \
+  -v surfsense-data:/data \
+  --name surfsense \
+  --restart unless-stopped \
+  ghcr.io/modsetter/surfsense:latest
+```
+
+शुरू करने के बाद, अपने ब्राउज़र में [http://localhost:3000](http://localhost:3000) खोलें।
+
+Docker Compose, मैनुअल इंस्टॉलेशन और अन्य डिप्लॉयमेंट विकल्पों के लिए, [डॉक्स](https://www.surfsense.com/docs/) देखें।

 ## प्रमुख विशेषताएं

-### 💡 **विचार**: 
- NotebookLM, Perplexity और Glean का ओपन सोर्स विकल्प। किसी भी LLM को अपने आंतरिक ज्ञान स्रोतों से जोड़ें और अपनी टीम के साथ रीयल-टाइम में सहयोग करें।
-### 📁 **कई फ़ाइल फ़ॉर्मेट अपलोड सपोर्ट**
- अपनी व्यक्तिगत फ़ाइलों *(दस्तावेज़, चित्र, वीडियो और **50+ फ़ाइल एक्सटेंशन** का समर्थन)* से सामग्री को अपने व्यक्तिगत ज्ञान आधार में सहेजें।
-### 🔍 **शक्तिशाली खोज**
- अपनी सहेजी गई सामग्री में कुछ भी तुरंत खोजें या शोध करें।
-### 💬 **अपनी सहेजी गई सामग्री के साथ चैट करें**
- प्राकृतिक भाषा में बातचीत करें और उद्धृत उत्तर प्राप्त करें।
-### 📄 **उद्धृत उत्तर**
- Perplexity की तरह उद्धृत उत्तर प्राप्त करें।
-### 🧩 **सार्वभौमिक अनुकूलता**
- OpenAI स्पेक और LiteLLM के माध्यम से लगभग किसी भी इंफ्रेंस प्रदाता को कनेक्ट करें।
-### 🔔 **गोपनीयता और स्थानीय LLM सपोर्ट**
- vLLM और Ollama जैसे स्थानीय LLMs के साथ बेहतरीन काम करता है।
-### 🏠 **सेल्फ-होस्ट करने योग्य**
- ओपन सोर्स और स्थानीय रूप से तैनात करना आसान।
-### 👥 **RBAC के साथ टीम सहयोग**
- सर्च स्पेस के लिए भूमिका-आधारित एक्सेस नियंत्रण
- अनुकूलन योग्य भूमिकाओं (मालिक, एडमिन, संपादक, दर्शक) के साथ टीम सदस्यों को आमंत्रित करें
- दस्तावेज़ों, चैट, कनेक्टर और सेटिंग्स के लिए विस्तृत अनुमतियां
- अपने संगठन के भीतर सुरक्षित रूप से ज्ञान आधार साझा करें
- टीम चैट रीयल-टाइम में अपडेट होते हैं और कमेंट थ्रेड में "चैट के बारे में चैट" करें
-### 🎙️ पॉडकास्ट
- अत्यंत तेज़ पॉडकास्ट जनरेशन एजेंट। (20 सेकंड से कम में 3 मिनट का पॉडकास्ट बनाता है।)
- अपनी चैट बातचीत को आकर्षक ऑडियो सामग्री में बदलें
- स्थानीय TTS प्रदाताओं का समर्थन (Kokoro TTS)
- कई TTS प्रदाताओं का समर्थन (OpenAI, Azure, Google Vertex AI)
+| विशेषता | विवरण |
+|----------|--------|
+| OSS विकल्प | रीयल-टाइम टीम सहयोग के साथ NotebookLM, Perplexity और Glean का सीधा प्रतिस्थापन |
+| 50+ फ़ाइल फ़ॉर्मेट | LlamaCloud, Unstructured या Docling (लोकल) के माध्यम से दस्तावेज़, चित्र, वीडियो अपलोड करें |
+| हाइब्रिड सर्च | हायरार्किकल इंडाइसेस और Reciprocal Rank Fusion के साथ सिमैंटिक + फुल टेक्स्ट सर्च |
+| उद्धृत उत्तर | अपने ज्ञान आधार के साथ चैट करें और Perplexity शैली के उद्धृत उत्तर पाएं |
+| डीप एजेंट आर्किटेक्चर | [LangChain Deep Agents](https://docs.langchain.com/oss/python/deepagents/overview) द्वारा संचालित, योजना, सब-एजेंट और फ़ाइल सिस्टम एक्सेस |
+| यूनिवर्सल LLM सपोर्ट | 100+ LLMs, 6000+ एम्बेडिंग मॉडल, सभी प्रमुख रीरैंकर्स OpenAI spec और LiteLLM के माध्यम से |
+| प्राइवेसी फर्स्ट | पूर्ण लोकल LLM सपोर्ट (vLLM, Ollama) आपका डेटा आपका रहता है |
+| टीम सहयोग | मालिक / एडमिन / संपादक / दर्शक भूमिकाओं के साथ RBAC, रीयल-टाइम चैट और कमेंट थ्रेड |
+| पॉडकास्ट जनरेशन | 20 सेकंड से कम में 3 मिनट का पॉडकास्ट; कई TTS प्रदाता (OpenAI, Azure, Kokoro) |
+| ब्राउज़र एक्सटेंशन | किसी भी वेबपेज को सहेजने के लिए क्रॉस-ब्राउज़र एक्सटेंशन, प्रमाणीकरण सुरक्षित पेज सहित |
+| 25+ कनेक्टर्स | सर्च इंजन, Google Drive, Slack, Teams, Jira, Notion, GitHub, Discord और [अधिक](#बाहरी-स्रोत) |
+| सेल्फ-होस्ट करने योग्य | ओपन सोर्स, Docker एक कमांड या प्रोडक्शन के लिए पूर्ण Docker Compose |

-### 🤖 **डीप एजेंट आर्किटेक्चर**
- [LangChain Deep Agents](https://docs.langchain.com/oss/python/deepagents/overview) द्वारा संचालित - ऐसे एजेंट जो योजना बना सकते हैं, सब-एजेंट का उपयोग कर सकते हैं, और जटिल कार्यों के लिए फ़ाइल सिस्टम का लाभ उठा सकते हैं।
+<details>
+<summary><b>बाहरी स्रोतों की पूरी सूची</b></summary>
+<a id="बाहरी-स्रोत"></a>

-### 📊 **उन्नत RAG तकनीकें**
- 100+ LLMs का समर्थन
- 6000+ एम्बेडिंग मॉडल का समर्थन
- सभी प्रमुख रीरैंकर्स का समर्थन (Pinecone, Cohere, Flashrank आदि)
- हायरार्किकल इंडाइसेस का उपयोग (2 स्तरीय RAG सेटअप)
- हाइब्रिड सर्च का उपयोग (सिमैंटिक + फुल टेक्स्ट सर्च, Reciprocal Rank Fusion के साथ)
-
-### ℹ️ **बाहरी स्रोत**
- सर्च इंजन (Tavily, LinkUp)
- SearxNG (सेल्फ-होस्टेड इंस्टेंस)
- Google Drive
- Slack
- Microsoft Teams
- Linear
- Jira
- ClickUp
- Confluence
- BookStack
- Notion
- Gmail
- YouTube वीडियो
- GitHub
- Discord
- Airtable
- Google Calendar
- Luma
- Circleback
- Elasticsearch
- Obsidian
- और भी बहुत कुछ आने वाला है.....
-
-## 📄 **समर्थित फ़ाइल एक्सटेंशन**
-
-| ETL सेवा | फ़ॉर्मेट | नोट्स |
-|-----------|----------|-------|
-| **LlamaCloud** | 50+ फ़ॉर्मेट | दस्तावेज़, प्रस्तुतियां, स्प्रेडशीट, चित्र |
-| **Unstructured** | 34+ फ़ॉर्मेट | मुख्य फ़ॉर्मेट + ईमेल समर्थन |
-| **Docling** | मुख्य फ़ॉर्मेट | स्थानीय प्रोसेसिंग, API कुंजी की आवश्यकता नहीं |
-
-**ऑडियो/वीडियो** (STT सेवा के माध्यम से): `.mp3`, `.wav`, `.mp4`, `.webm`, आदि।
-
-### 🔖 क्रॉस-ब्राउज़र एक्सटेंशन
- SurfSense एक्सटेंशन का उपयोग किसी भी वेबपेज को सहेजने के लिए किया जा सकता है।
- इसका मुख्य उपयोग प्रमाणीकरण द्वारा संरक्षित वेबपेजों को सहेजना है।
+सर्च इंजन (Tavily, LinkUp) · SearxNG · Google Drive · Slack · Microsoft Teams · Linear · Jira · ClickUp · Confluence · BookStack · Notion · Gmail · YouTube वीडियो · GitHub · Discord · Airtable · Google Calendar · Luma · Circleback · Elasticsearch · Obsidian, और भी बहुत कुछ आने वाला है।

+</details>


 ## फ़ीचर अनुरोध और भविष्य
@ -126,120 +126,29 @@ https://github.com/user-attachments/assets/a0a16566-6967-4374-ac51-9b3e07fbecd7

 [SurfSense Discord](https://discord.gg/ejRNvftDp9) में शामिल हों और SurfSense के भविष्य को आकार देने में मदद करें!

-## 🚀 रोडमैप
+## रोडमैप

 हमारे विकास की प्रगति और आने वाली सुविधाओं से अपडेट रहें!  
 हमारा सार्वजनिक रोडमैप देखें और अपने विचार या फ़ीडबैक दें:

-**📋 रोडमैप चर्चा:** [SurfSense 2025-2026 Roadmap: Deep Agents, Real-Time Collaboration & MCP Servers](https://github.com/MODSetter/SurfSense/discussions/565)
+**रोडमैप चर्चा:** [SurfSense 2026 Roadmap](https://github.com/MODSetter/SurfSense/discussions/565)

-**📊 कानबन बोर्ड:** [SurfSense Project Board](https://github.com/users/MODSetter/projects/3)
+**कानबन बोर्ड:** [SurfSense Project Board](https://github.com/users/MODSetter/projects/3)


-## कैसे शुरू करें?
+## योगदान करें 

-### Docker के साथ त्वरित शुरुआत 🐳
-
-> [!TIP]
-> प्रोडक्शन डिप्लॉयमेंट के लिए, पूर्ण [Docker Compose सेटअप](https://www.surfsense.com/docs/docker-installation) का उपयोग करें जो अधिक नियंत्रण और स्केलेबिलिटी प्रदान करता है।
-
-**Linux/macOS:**
-
-```bash
-docker run -d -p 3000:3000 -p 8000:8000 -p 5133:5133 \
-  -v surfsense-data:/data \
-  --name surfsense \
-  --restart unless-stopped \
-  ghcr.io/modsetter/surfsense:latest
-```
-
-**Windows (PowerShell):**
-
-```powershell
-docker run -d -p 3000:3000 -p 8000:8000 -p 5133:5133 `
-  -v surfsense-data:/data `
-  --name surfsense `
-  --restart unless-stopped `
-  ghcr.io/modsetter/surfsense:latest
-```
-
-**कस्टम कॉन्फ़िगरेशन के साथ:**
-
-आप `-e` फ़्लैग का उपयोग करके कोई भी एन्वायरनमेंट वेरिएबल पास कर सकते हैं:
-
-```bash
-docker run -d -p 3000:3000 -p 8000:8000 -p 5133:5133 \
-  -v surfsense-data:/data \
-  -e EMBEDDING_MODEL=openai://text-embedding-ada-002 \
-  -e OPENAI_API_KEY=your_openai_api_key \
-  -e AUTH_TYPE=GOOGLE \
-  -e GOOGLE_OAUTH_CLIENT_ID=your_google_client_id \
-  -e GOOGLE_OAUTH_CLIENT_SECRET=your_google_client_secret \
-  -e ETL_SERVICE=LLAMACLOUD \
-  -e LLAMA_CLOUD_API_KEY=your_llama_cloud_key \
-  --name surfsense \
-  --restart unless-stopped \
-  ghcr.io/modsetter/surfsense:latest
-```
-
-> [!NOTE]
-> - यदि HTTPS के साथ रिवर्स प्रॉक्सी के पीछे डिप्लॉय कर रहे हैं, तो `-e BACKEND_URL=https://api.yourdomain.com` जोड़ें
-
-शुरू करने के बाद, SurfSense तक पहुंचें:
- **फ्रंटएंड**: [http://localhost:3000](http://localhost:3000)
- **बैकएंड API**: [http://localhost:8000](http://localhost:8000)
- **API डॉक्स**: [http://localhost:8000/docs](http://localhost:8000/docs)
- **Electric-SQL**: [http://localhost:5133](http://localhost:5133)
-
-**उपयोगी कमांड:**
-
-```bash
-docker logs -f surfsense      # लॉग देखें
-docker stop surfsense         # रोकें
-docker start surfsense        # शुरू करें
-docker rm surfsense           # हटाएं (डेटा वॉल्यूम में सुरक्षित रहता है)
-```
-
-### इंस्टॉलेशन विकल्प
-
-SurfSense शुरू करने के लिए कई विकल्प प्रदान करता है:
-
-1. **[SurfSense Cloud](https://www.surfsense.com/login)** - बिना किसी सेटअप के SurfSense आज़माने का सबसे आसान तरीका।
-   - इंस्टॉलेशन की आवश्यकता नहीं
-   - सभी सुविधाओं तक तत्काल पहुंच
-   - जल्दी शुरू करने के लिए बिल्कुल सही
-
-2. **Docker त्वरित शुरुआत (ऊपर)** - एक ही कमांड से SurfSense को स्थानीय रूप से चलाएं।
-   - PostgreSQL, Redis और सभी सेवाओं के साथ ऑल-इन-वन इमेज
-   - मूल्यांकन, विकास और छोटे डिप्लॉयमेंट के लिए बिल्कुल सही
-   - Docker वॉल्यूम के माध्यम से डेटा पर्सिस्ट
-
-3. **[Docker Compose (प्रोडक्शन)](https://www.surfsense.com/docs/docker-installation)** - अलग-अलग सेवाओं के साथ पूर्ण स्टैक डिप्लॉयमेंट।
-   - वेब UI के माध्यम से डेटाबेस प्रबंधन के लिए pgAdmin शामिल
-   - `.env` फ़ाइल के माध्यम से एन्वायरनमेंट वेरिएबल कस्टमाइज़ेशन का समर्थन
-   - लचीले डिप्लॉयमेंट विकल्प (पूर्ण स्टैक या केवल मुख्य सेवाएं)
-   - सेवाओं के स्वतंत्र स्केलिंग के साथ प्रोडक्शन के लिए बेहतर
-
-4. **[मैनुअल इंस्टॉलेशन](https://www.surfsense.com/docs/manual-installation)** - उन उपयोगकर्ताओं के लिए जो अपने सेटअप पर अधिक नियंत्रण चाहते हैं या अपने डिप्लॉयमेंट को कस्टमाइज़ करना चाहते हैं।
-
-Docker और मैनुअल इंस्टॉलेशन गाइड में Windows, macOS और Linux के लिए विस्तृत OS-विशिष्ट निर्देश शामिल हैं।
-
-सेल्फ-होस्टिंग इंस्टॉलेशन से पहले, [पूर्वापेक्षा सेटअप चरण](https://www.surfsense.com/docs/) पूरा करना सुनिश्चित करें, जिसमें शामिल हैं:
- प्रमाणीकरण सेटअप (वैकल्पिक - डिफ़ॉल्ट LOCAL प्रमाणीकरण)
- **फ़ाइल प्रोसेसिंग ETL सेवा** (वैकल्पिक - डिफ़ॉल्ट Docling):
-  - Docling (डिफ़ॉल्ट, स्थानीय प्रोसेसिंग, API कुंजी की आवश्यकता नहीं, PDF, Office दस्तावेज़, चित्र, HTML, CSV का समर्थन)
-  - Unstructured.io API कुंजी (34+ फ़ॉर्मेट का समर्थन)
-  - LlamaIndex API कुंजी (उन्नत पार्सिंग, 50+ फ़ॉर्मेट का समर्थन)
- आपके उपयोग के अनुसार अन्य API कुंजियां
-
-
-## योगदान करें
-
-योगदान का बहुत स्वागत है! योगदान एक ⭐ जितना छोटा हो सकता है या issues खोजना और बनाना भी।
+योगदान का बहुत स्वागत है! योगदान एक स्टार जितना छोटा हो सकता है या issues खोजना और बनाना भी।
 बैकएंड की फ़ाइन-ट्यूनिंग हमेशा वांछित है।

 विस्तृत योगदान दिशानिर्देशों के लिए, कृपया हमारी [CONTRIBUTING.md](CONTRIBUTING.md) फ़ाइल देखें।

+## योगदानकर्ता
+
+<a href="https://github.com/MODSetter/SurfSense/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=MODSetter/SurfSense" />
+</a>
+
 ## Star इतिहास

 <a href="https://www.star-history.com/#MODSetter/SurfSense&Date">