From 8cee7200ffc7f5a152416129963a256bcf67bbed Mon Sep 17 00:00:00 2001 From: FacerAin Date: Thu, 14 Dec 2023 10:12:58 +0900 Subject: [PATCH] docs: update README --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4d49967..dbfdaeb 100644 --- a/README.md +++ b/README.md @@ -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** @@ -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).

(back to top)