doc(readme): add openAI dependency disclaimer

UBC-MDS · Jan 31, 2025 · b3c9713 · b3c9713
1 parent 8b195f0
commit b3c9713
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -38,6 +38,10 @@ def square(base: int, pow: int) -> int:
 print(generate_docstring_template(square, output_file=None))
 ```
 
+## OpenAI Dependency:
+
+`fml_doc_gen` requires an OpenAI API key to generate docstrings. You can set your API key using the `OPENAI_API_KEY` environment variable. Check our our documentation [here](https://readthedocs.org/projects/fml-doc-gen/badge/?version=latest) for more information.
+
 ## Functions Included
 
 - **`generate_docstring_template(func: Callable, output_file: str, auto_generate: bool = False) -> str`**: