Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
FacerAin committed Dec 14, 2023
1 parent 6da7934 commit 8cee720
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ I recommend building your environment on top of a **virtual environment** (e.g.,
* **Run application**

```sh
make run

or

uvicorn app.main:app
```
* **Linting & Testing**
Expand All @@ -81,8 +85,9 @@ I recommend building your environment on top of a **virtual environment** (e.g.,


## :globe_with_meridians: Features
- **Summarize and quiz** lecture notes or videos.
- You can input text, PDF, or video.
- Providing API Endpoint through FastAPI
- Generating answers using the Agent system
- Document search and RAG using Pinecone Retriever
- For more information, please refer to the [API documentation](http://facerain-dev.iptime.org:1009/redoc).

<p align="right">(<a href="#readme-top">back to top</a>)</p>
Expand Down

0 comments on commit 8cee720

Please sign in to comment.