Doc improvments

README.md

@@ -7,12 +7,9 @@ A client for the Overmind API that provides easy access to AI provider endpoints
 
 ## Features
 
-- **Dynamic Provider Access**: Access any supported AI provider through a unified interface
-- **Policy Enforcement**: Automatically applies input and output policies to your requests
-- **Agent Management**: Create, list, edit, and delete agents
-- **Policy Management**: Manage custom policies for your business
-- **Invocation History**: Track and manage your API invocations
-- **Type Safety**: Full type hints and Pydantic models for request/response validation
+- **Easy Integration**: Use major providers like OpenAI with the same call signatures
+- **Policy Enforcement**: Apply customizable policies to your LLM inputs and outputs
+- **Observability**: Log and explore all LLM calls and policy results
 
 ## Installation
 
@@ -96,7 +93,7 @@ response.summary()
 ```
 ## Further usage
 
-There is a more detailed [tutorial notebook](docs/overmind_tutorial.ipynb) available.
+There is a more detailed [tutorial notebook](https://github.com/overmind-core/overmind-python/blob/main/docs/overmind_tutorial.ipynb) available.
 
 We are not storing your API keys and you are solely responsible for managing them and the associated costs.
 

docs/overmind_tutorial.ipynb

@@ -125,7 +125,7 @@
    "id": "efc8b845-53d3-462d-b745-cc326c5f2948",
    "metadata": {},
    "source": [
-    "The result will be an InvocationResponse, with .summary() providing an overview. To access more details, including the original response from LLM client see full definition at [Invocations](Invocations.md)"
+    "The result will be an InvocationResponse, with .summary() providing an overview. To access more details, including the original response from LLM client see full definition at [Invocations](https://github.com/overmind-core/overmind-python/blob/main/docs/Invocations.md)"
    ]
   },
   {
@@ -135,7 +135,7 @@
    "source": [
     "# Experimenting with Policy Templates\n",
     "\n",
-    "All client calls can be extended with `input_policies` and `output_policies` aruments. The below is the example setting up PII anonymisation and LLM judge. For all current templates see [Policies.md](Policies.md)\n",
+    "All client calls can be extended with `input_policies` and `output_policies` aruments. The below is the example setting up PII anonymisation and LLM judge. For all current templates see [Policies.md](https://github.com/overmind-core/overmind-python/blob/main/docs/Policies.md)\n",
     "\n",
     "This set up allows you to experiment with different templates and parameters before you save them and attach to a new agent."
    ]

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "overmind"
-version = "0.1.6"
+version = "0.1.7"
 description = "Python client for Overmind API"
 authors = ["Overmind Ltd"]
 readme = "README.md"