mirror of
https://github.com/StanGirard/quivr.git
synced 2024-11-24 05:55:13 +03:00
15d43c492d
# Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. ## Checklist before requesting a review Please delete options that are not relevant. - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented hard-to-understand areas - [ ] I have ideally added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged ## Screenshots (if appropriate):
97 lines
3.0 KiB
Plaintext
97 lines
3.0 KiB
Plaintext
---
|
|
title: 🚀 Welcome to Quivr
|
|
description: Quivr is your Second Brain that can acts as your personal assistant.
|
|
---
|
|
|
|
[Quivr](https://quivr.app) is your **Second Brain** that can acts as your **personal assistant**.
|
|
|
|
It can:
|
|
- **Answer questions** to the **files** that you uploaded
|
|
- **Interact** with the **applications** that you connected to Quivr
|
|
|
|
<Tip>
|
|
**Our goal** is to make Quivr the **best open-source personal assistant** that is powered by your knowledge and your applications 🔥
|
|
It will remain open-source
|
|
</Tip>
|
|
|
|
## What does it do ?
|
|
|
|
|
|
<div style={{ textAlign: 'center' }}>
|
|
<video width="640" height="480" controls>
|
|
<source src="https://quivr-cms.s3.eu-west-3.amazonaws.com/singlestore_demo_quivr_232893659c.mp4" type="video/mp4"/>
|
|
Your browser does not support the video tag.
|
|
</video>
|
|
</div>
|
|
|
|
## How to get started ? 👀
|
|
|
|
<Tip>
|
|
It takes less than **5 seconds** to get started with Quivr. You can even use your Google account to sign up.
|
|
</Tip>
|
|
|
|
<Steps>
|
|
<Step title="Create an account">
|
|
Go to [Quivr](https://quivr.app) and create an account.
|
|
</Step>
|
|
<Step title="Upload a file">
|
|
Upload a file to Quivr.
|
|
</Step>
|
|
<Step title="Ask Questions to Quivr">
|
|
Ask questions to Quivr about your file.
|
|
</Step>
|
|
</Steps>
|
|
|
|
|
|
|
|
|
|
## How can you leverage Quivr ? 🚀
|
|
|
|
You can use Quivr to:
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Search in files" icon="searchengin">
|
|
Quivr allows you to easily ask questions about your files
|
|
</Accordion>
|
|
<Accordion title="Cross-search" icon="shuffle">
|
|
Tired of Cross referencing your information between files ?
|
|
</Accordion>
|
|
<Accordion title="Store your knowledge" icon="database">
|
|
Store all your knowledge in one place
|
|
</Accordion>
|
|
<Accordion title="Share your knowledge" icon="share">
|
|
Share your knowledge with your team by leveraging the collaboration features
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
|
|
## Features 🤗
|
|
|
|
### Public & Private Brains
|
|
|
|
You can create **public** and **private** brains.
|
|
|
|
- **Public** brains are **searchable** by everyone on Quivr
|
|
- **Private** brains are **only searchable** by you
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Public" icon="globe">
|
|
A public brain is a brain that is searchable by everyone on Quivr. You can make a brain public by clicking on the **public** button on the brain page.
|
|
</Accordion>
|
|
<Accordion title="Private" icon="lock">
|
|
A private brain is a brain that is only searchable by you. You can make a brain private by clicking on the **private** button on the brain page.
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
|
|
You can share your brains with a set of people by using their emails. This means that you can **collaborate** with your team on a brain without making it public.
|
|
|
|
### Ask Questions
|
|
|
|
You can **ask questions** to Quivr. Quivr will **answer** your questions by leveraging the **knowledge** that you uploaded to Quivr.
|
|
|
|
### Custom Personality
|
|
|
|
You can **customize** the personality of Quivr by changing the **prompt** of your brain. You could tell your brain to always answer with a **funny** or **serious** tone or act like a **robot** or a **human**.
|
|
|