diff options
| author | terminaldweller <thabogre@gmail.com> | 2022-07-04 14:05:28 +0000 |
|---|---|---|
| committer | terminaldweller <thabogre@gmail.com> | 2022-07-04 14:05:28 +0000 |
| commit | b33b4766f2e2a4019e82f74b86804bdae0a3460f (patch) | |
| tree | 3913a88fc3dc26ac66896b1e88a7c784790a7b88 | |
| parent | added links to the live instance (diff) | |
| download | devourer-b33b4766f2e2a4019e82f74b86804bdae0a3460f.tar.gz devourer-b33b4766f2e2a4019e82f74b86804bdae0a3460f.zip | |
updated readme
| -rw-r--r-- | README.md | 6 |
1 files changed, 6 insertions, 0 deletions
@@ -3,11 +3,17 @@ [](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.<br/> Right now it can get text out of certain formats, summarize them or not and turn them into audio or not.<br/> There is a little feature that searches for a term on wikipedia and one that extracts requirements from RFCs.<br/> 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.<br/> +## Live Instance There is a live instance on https://mila.terminaldweller.com/mila.<br/> You can look at the docs [here](https://mila.terminalweller.com/docs).<br/> + +## 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.<br/> |