Skip to content

Commit

Permalink
points to note
Browse files Browse the repository at this point in the history
  • Loading branch information
ADBond committed Sep 26, 2024
1 parent d019b47 commit 8df6256
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ Alternatively you can install the package from github:
pip install git+https://github.com/ADBond/[email protected]
```

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.
Nevertheless if you depend on this package it is recommended to pin a version to avoid any disruption this may cause.

## Use

### Clickhouse server
Expand Down Expand Up @@ -185,6 +188,13 @@ settings = SettingsCreator(
)
```

## Support

If you have difficulties with the package you can [open an issue](https://github.com/ADBond/splinkclickhouse/issues).
You may also [suggest changes by opening a PR](https://github.com/ADBond/splinkclickhouse/pulls), although it may be best to discuss in an issue beforehand.

This package is 'unofficial', in that it is not directly supported by the Splink team. Maintenance / improvements will be done on a 'best effort' basis where resources allow.

## Known issues / caveats

### Datetime parsing
Expand Down

0 comments on commit 8df6256

Please sign in to comment.