Skip to content

Commit

Permalink
docs links in README
Browse files Browse the repository at this point in the history
  • Loading branch information
ADBond committed Feb 6, 2025
1 parent 013e9f7 commit 14de08e
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`

Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 14de08e

Please sign in to comment.