diff --git a/README.md b/README.md index dc20ebe..7a61ba0 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,14 @@ # docugen -Generating documentation using OpenAPI LLM models +Generating documentation using OpenAI LLMs + +![](example/out.png) [Example input](example/example_code.py) [Example output](example/example_code-doc.md) + +## Spec + +- Connecting to ChatGPT with [revChatGPT](https://github.com/acheong08/ChatGPT) +- Currently only supports Python source code & extracts top-level functions only diff --git a/example/out.png b/example/out.png new file mode 100644 index 0000000..0d0664e Binary files /dev/null and b/example/out.png differ