From 08d89accd5688527c9a751f4e0e76721acb5a804 Mon Sep 17 00:00:00 2001 From: ipfreely-uk Date: Mon, 8 Apr 2024 18:46:27 +0100 Subject: [PATCH] README --- README.md | 35 ++++++++++++++++++++++++++++++++--- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 22beb02..b298f35 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,36 @@ ALL CODE IN ALPHA STATE # IPFreely.uk -[![Go](https://github.com/ipfreely-uk/go/actions/workflows/go.yml/badge.svg)](https://github.com/ipfreely-uk/go/actions/workflows/go.yml) -[![Document](https://github.com/ipfreely-uk/go/actions/workflows/document.yml/badge.svg)](https://github.com/ipfreely-uk/go/actions/workflows/document.yml) - IP address manipulation library written in Go. +This library treats IP addresses as +[generic](https://go.dev/doc/tutorial/generics) +unsigned integers capable of arithmetic and bitwise operations. + +## Packages + +Add an import statement to [go.mod](https://go.dev/doc/modules/gomod-ref) to utilise. + +| Package | Purpose | +|----------------------------------------------------|-----------------------------------------| +| `import github.com/ipfreely-uk/go/ip` | Core IP address types | +| `import github.com/ipfreely-uk/go/ip/compare` | Generic comparison types and functions | +| `import github.com/ipfreely-uk/go/ip/network` | IP address collection & iteration types | +| `import github.com/ipfreely-uk/go/ip/network/cidr` | CIDR notation functions | +| `import github.com/ipfreely-uk/go/ip/subnet` | CIDR subnet functions | + +## Versus Standard Library + +Selective comparison with standard library types in +[net](https://pkg.go.dev/net@go1.22.2) and [netip](https://pkg.go.dev/net/netip@go1.22.2). + +_TODO_ + +## Links + + - [IPFreely.uk Website](https://ipfreely.uk) + - [Source Code](https://github.com/ipfreely-uk/) + - [Documentation](https://pkg.go.dev/github.com/ipfreely-uk/go) + +## Continuous Integration + +[![Go](https://github.com/ipfreely-uk/go/actions/workflows/go.yml/badge.svg)](https://github.com/ipfreely-uk/go/actions/workflows/go.yml)