From 14de08e35b9667066da4df97694cf57f41bbf474 Mon Sep 17 00:00:00 2001
From: ADBond <48208438+ADBond@users.noreply.github.com>
Date: Thu, 6 Feb 2025 17:13:54 +0000
Subject: [PATCH] docs links in README

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 9b8b1b8..ae84368 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
 [![pypi](https://img.shields.io/github/v/release/adbond/splinkclickhouse?include_prereleases)](https://pypi.org/project/splinkclickhouse/#history)
 [![Downloads](https://static.pepy.tech/badge/splinkclickhouse)](https://pepy.tech/project/splinkclickhouse)
 [![codecov](https://codecov.io/github/adbond/splinkclickhouse/graph/badge.svg?token=NUHM8IPJL4)](https://codecov.io/github/adbond/splinkclickhouse)
+[![Docs](https://img.shields.io/badge/documentation-purple?style=flat)](https://adbond.github.io/splinkclickhouse/)
 
 # `splinkclickhouse`
 
@@ -36,6 +37,10 @@ conda install conda-forge::splinkclickhouse
 
 Note that the `conda` version will only be able to use [the Clickhouse server functionality](#clickhouse-server) as `chdb` is not currently available within `conda`.
 
+## Documentation
+
+Head over to [the docs site](https://adbond.github.io/splinkclickhouse/) for details on using the package. 
+
 ### Caveats
 
 While the package is in early development there will may be breaking changes in new versions without warning, although these _should_ only occur in new minor versions.