From b33b4766f2e2a4019e82f74b86804bdae0a3460f Mon Sep 17 00:00:00 2001 From: terminaldweller Date: Mon, 4 Jul 2022 18:35:28 +0430 Subject: updated readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 63b6d87..6f8374a 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,17 @@ [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) # devourer + +## About Devourer is meant to be a sort of a knowledge aggregator though it has quite a long way to get there.
Right now it can get text out of certain formats, summarize them or not and turn them into audio or not.
There is a little feature that searches for a term on wikipedia and one that extracts requirements from RFCs.
To see what endpoints are present and how to use them or interact with them go to `/docs`. Devourer is powered by fastapi. Everything is in its default location.
+## Live Instance There is a live instance on https://mila.terminaldweller.com/mila.
You can look at the docs [here](https://mila.terminalweller.com/docs).
+ +## How to Run +Run one of the two compose files. The test compose file uses self-signed certificates for local testing since devourer only supports https.
-- cgit v1.2.3