Skip to content

Commit

Permalink
readme format
Browse files Browse the repository at this point in the history
  • Loading branch information
martindurant committed Aug 8, 2024
1 parent 972ca42 commit ce4e49f
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
Akimbo-ip
---------
=========

Extension enabling fast vector processing of IPv4 and IPv6 values
within nested/ragged columns of dataframes.

(experimental)

Installation
~~~~~~~~~~~~
------------

Run one of the following

```bash
> pip install git+https://github.com/intake/akimbo-ip
> pip install git+https://github.com/intake/akimbo-ip # dev version
> pip install akimbo-ip # released version
```

Model
~~~~~
-----

- IPv4 addresses are (fixed) length 4 bytestrings, but can be represented
by any 4-bye value, e.g., uint32
Expand All @@ -27,7 +30,7 @@ We can convert between hostmasks, netmasks and prefix lengths.
Some methods

Usage
~~~~~
-----

```python
>>> import akimbo.pandas
Expand Down

0 comments on commit ce4e49f

Please sign in to comment.