From 1f23136c748de5a06246904d9e7225377a9f77cd Mon Sep 17 00:00:00 2001 From: Lorenzo Drudi Date: Sat, 27 Apr 2024 12:07:52 +0200 Subject: [PATCH] docs: improve docs. --- README.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 070d42a..6f9701d 100644 --- a/README.rst +++ b/README.rst @@ -5,8 +5,10 @@ OpenAI Cost Logger ================== -Simple **cost logger** for **OpenAI requests**. -Track the cost of every request you make to OpenAI and visualize them in a user-friendly way. +* Simple **cost logger** for **OpenAI requests**. +* Track the cost of every request you make to OpenAI and visualize them in a user-friendly way. +* Homepage on `PyPI `_. +* `Demo file `_ with a usage example. How to install: --------------- @@ -21,9 +23,6 @@ How to install: from openai_cost_logger import OpenAICostLoggerUtils from openai_cost_logger import DEFAULT_LOG_PATH, MODELS_COST -* Homepage on `PyPI `_. -* `Demo file `_ with a usage example. - Key Features: ------------- * Track the cost of every request you make and save them in a JSON file. @@ -41,6 +40,6 @@ Note: Viz example: ------------- -.. image::https://drive.google.com/file/d/1lbmRJCe5VHqom0bdHzE2xi09lSfsp_Bm/view?usp=sharing +.. image:: https://drive.google.com/file/d/1lbmRJCe5VHqom0bdHzE2xi09lSfsp_Bm/view?usp=sharing :alt: Viz example (prints + plot) :align: center