Skip to content

Commit 3ce7dd3

Browse files
erichutchinsclaude
andcommitted
docs: add badges to README (docs, Python versions, uv, ruff, ty, license, Claude, Gemini)
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent a18eb68 commit 3ce7dd3

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
Polars IPTools is a Rust-based extension to accelerates IP address manipulation and enrichment in Polars dataframes. This library includes various utility functions for working with IPv4 and IPv6 addresses and geoip and anonymization/proxy enrichment using MaxMind databases.
44

5+
[![Documentation](https://img.shields.io/badge/docs-mkdocs-blue)](https://erichutchins.github.io/polars_iptools/)
6+
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/polars-iptools)](https://pypi.org/project/polars-iptools/)
7+
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
8+
[![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
9+
[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/refs/heads/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
10+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
11+
[![Claude](https://img.shields.io/badge/Claude-D97757?logo=claude&logoColor=fff)](https://claude.ai)
12+
[![Gemini](https://img.shields.io/badge/Gemini-8E75FF?logo=googlegemini&logoColor=fff)](https://antigravity.google)
13+
514
## Install
615

716
```shell
@@ -161,7 +170,7 @@ Set the `MAXMIND_MMDB_DIR` environment variable to tell the extension where thes
161170
export MAXMIND_MMDB_DIR=/path/to/your/mmdb/files
162171
# or Windows users
163172
set MAXMIND_MMDB_DIR=c:\path\to\your\mmdb\files
164-
````
173+
```
165174

166175
If the environment is not set, polars_iptools will check two other common locations (on Mac/Linux):
167176

@@ -178,7 +187,7 @@ If you're a Spur customer, export the feed as `spur.mmdb` and specify its locati
178187
export SPUR_MMDB_DIR=/path/to/spur/mmdb
179188
# or Windows users
180189
set SPUR_MMDB_DIR=c:\path\to\spur\mmdb
181-
````
190+
```
182191

183192
## Credit
184193

0 commit comments

Comments
 (0)