Skip to content

Commit f6ffa9e

Browse files
committed
feat(readme): enhance readme
1 parent f9e6758 commit f6ffa9e

File tree

2 files changed

+36
-53
lines changed

2 files changed

+36
-53
lines changed

.assets/sponsers/warp.png

433 KB
Loading

README.md

Lines changed: 36 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,57 @@
1-
# 🚀 Perplexica - An AI-powered search engine 🔎 <!-- omit in toc -->
1+
# Perplexica 🔍
2+
3+
[![GitHub Repo stars](https://img.shields.io/github/stars/ItzCrazyKns/Perplexica?style=social)](https://github.com/ItzCrazyKns/Perplexica/stargazers)
4+
[![GitHub forks](https://img.shields.io/github/forks/ItzCrazyKns/Perplexica?style=social)](https://github.com/ItzCrazyKns/Perplexica/network/members)
5+
[![GitHub watchers](https://img.shields.io/github/watchers/ItzCrazyKns/Perplexica?style=social)](https://github.com/ItzCrazyKns/Perplexica/watchers)
6+
[![Docker Pulls](https://img.shields.io/docker/pulls/itzcrazykns1337/perplexica?color=blue)](https://hub.docker.com/r/itzcrazykns1337/perplexica)
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/ItzCrazyKns/Perplexica/blob/master/LICENSE)
8+
[![GitHub last commit](https://img.shields.io/github/last-commit/ItzCrazyKns/Perplexica?color=green)](https://github.com/ItzCrazyKns/Perplexica/commits/master)
9+
[![Discord](https://dcbadge.limes.pink/api/server/26aArMy8tT?style=flat)](https://discord.gg/26aArMy8tT)
210

3-
<div align="center" markdown="1">
4-
<sup>Special thanks to:</sup>
5-
<br>
6-
<br>
7-
<a href="https://www.warp.dev/perplexica">
8-
<img alt="Warp sponsorship" width="400" src="https://github.com/user-attachments/assets/775dd593-9b5f-40f1-bf48-479faff4c27b">
9-
</a>
11+
Perplexica is a **privacy-focused AI answering engine** that runs entirely on your own hardware. It combines knowledge from the vast internet with support for **local LLMs** (Ollama) and cloud providers (OpenAI, Claude, Groq), delivering accurate answers with **cited sources** while keeping your searches completely private.
1012

11-
### [Warp, the AI Devtool that lives in your terminal](https://www.warp.dev/perplexica)
13+
![preview](.assets/demo.gif)
1214

13-
[Available for MacOS, Linux, & Windows](https://www.warp.dev/perplexica)
15+
Want to know more about its architecture and how it works? You can read it [here](https://github.com/ItzCrazyKns/Perplexica/tree/master/docs/architecture/README.md).
1416

15-
</div>
17+
## ✨ Features
1618

17-
<hr/>
19+
🤖 **Support for all major AI providers** - Use local LLMs through Ollama or connect to OpenAI, Anthropic Claude, Google Gemini, Groq, and more. Mix and match models based on your needs.
1820

19-
[![Discord](https://dcbadge.limes.pink/api/server/26aArMy8tT?style=flat)](https://discord.gg/26aArMy8tT)
21+
**Smart search modes** - Choose Balanced Mode for everyday searches, Fast Mode when you need quick answers, or wait for Quality Mode (coming soon) for deep research.
2022

21-
![preview](.assets/perplexica-screenshot.png?)
23+
🎯 **Six specialized focus modes** - Get better results with modes designed for specific tasks: Academic papers, YouTube videos, Reddit discussions, Wolfram Alpha calculations, writing assistance, or general web search.
2224

23-
## Table of Contents <!-- omit in toc -->
25+
🔍 **Web search powered by SearxNG** - Access multiple search engines while keeping your identity private. Support for Tavily and Exa coming soon for even better results.
2426

25-
- [Overview](#overview)
26-
- [Preview](#preview)
27-
- [Features](#features)
28-
- [Installation](#installation)
29-
- [Getting Started with Docker (Recommended)](#getting-started-with-docker-recommended)
30-
- [Non-Docker Installation](#non-docker-installation)
31-
- [Ollama Connection Errors](#ollama-connection-errors)
32-
- [Lemonade Connection Errors](#lemonade-connection-errors)
33-
- [Using as a Search Engine](#using-as-a-search-engine)
34-
- [Using Perplexica's API](#using-perplexicas-api)
35-
- [Expose Perplexica to a network](#expose-perplexica-to-network)
36-
- [One-Click Deployment](#one-click-deployment)
37-
- [Upcoming Features](#upcoming-features)
38-
- [Support Us](#support-us)
39-
- [Donations](#donations)
40-
- [Contribution](#contribution)
41-
- [Help and Support](#help-and-support)
27+
📷 **Image and video search** - Find visual content alongside text results. Search isn't limited to just articles anymore.
4228

43-
## Overview
29+
📄 **File uploads** - Upload documents and ask questions about them. PDFs, text files, images - Perplexica understands them all.
4430

45-
Perplexica is an open-source AI-powered searching tool or an AI-powered search engine that goes deep into the internet to find answers. Inspired by Perplexity AI, it's an open-source option that not just searches the web but understands your questions. It uses advanced machine learning algorithms like similarity searching and embeddings to refine results and provides clear answers with sources cited.
31+
🌐 **Search specific domains** - Limit your search to specific websites when you know where to look. Perfect for technical documentation or research papers.
4632

47-
Using SearxNG to stay current and fully open source, Perplexica ensures you always get the most up-to-date information without compromising your privacy.
33+
💡 **Smart suggestions** - Get intelligent search suggestions as you type, helping you formulate better queries.
4834

49-
Want to know more about its architecture and how it works? You can read it [here](https://github.com/ItzCrazyKns/Perplexica/tree/master/docs/architecture/README.md).
35+
📚 **Discover** - Browse interesting articles and trending content throughout the day. Stay informed without even searching.
36+
37+
🕒 **Search history** - Every search is saved locally so you can revisit your discoveries anytime. Your research is never lost.
5038

51-
## Preview
39+
**More coming soon** - We're actively developing new features based on community feedback. Join our Discord to help shape Perplexica's future!
5240

53-
![video-preview](.assets/perplexica-preview.gif)
41+
## Sponsors
5442

55-
## Features
43+
Perplexica's development is powered by the generous support of our sponsors. Their contributions help keep this project free, open-source, and accessible to everyone.
5644

57-
- **Local LLMs**: You can utilize local LLMs such as Qwen, DeepSeek, Llama, and Mistral.
58-
- **Two Main Modes:**
59-
- **Copilot Mode:** (In development) Boosts search by generating different queries to find more relevant internet sources. Like normal search instead of just using the context by SearxNG, it visits the top matches and tries to find relevant sources to the user's query directly from the page.
60-
- **Normal Mode:** Processes your query and performs a web search.
61-
- **Focus Modes:** Special modes to better answer specific types of questions. Perplexica currently has 6 focus modes:
62-
- **All Mode:** Searches the entire web to find the best results.
63-
- **Writing Assistant Mode:** Helpful for writing tasks that do not require searching the web.
64-
- **Academic Search Mode:** Finds articles and papers, ideal for academic research.
65-
- **YouTube Search Mode:** Finds YouTube videos based on the search query.
66-
- **Wolfram Alpha Search Mode:** Answers queries that need calculations or data analysis using Wolfram Alpha.
67-
- **Reddit Search Mode:** Searches Reddit for discussions and opinions related to the query.
68-
- **Current Information:** Some search tools might give you outdated info because they use data from crawling bots and convert them into embeddings and store them in a index. Unlike them, Perplexica uses SearxNG, a metasearch engine to get the results and rerank and get the most relevant source out of it, ensuring you always get the latest information without the overhead of daily data updates.
69-
- **API**: Integrate Perplexica into your existing applications and make use of its capibilities.
45+
<div align="center">
46+
47+
48+
<a href="https://www.warp.dev/perplexica">
49+
<img alt="Warp Terminal" src=".assets/sponsers/warp.png" width="100%">
50+
</a>
7051

71-
It has many more features like image and video search. Some of the planned features are mentioned in [upcoming features](#upcoming-features).
52+
**[Warp](https://www.warp.dev/perplexica)** - The AI-powered terminal revolutionizing development workflows
53+
54+
</div>
7255

7356
## Installation
7457

0 commit comments

Comments
 (0)