Breaking: redesigned several library APIs (#56)

Author: zefir-git

.github/workflows/ci.yml

@@ -136,7 +136,7 @@ jobs:
 
       - name: Generate docs
         if: "!github.event.release.prerelease"
-        run: npm run docs
+        run: npm run docs:build
 
       - name: Set up GitHub pages
         if: "!github.event.release.prerelease"
@@ -146,7 +146,7 @@ jobs:
         if: "!github.event.release.prerelease"
         uses: actions/upload-pages-artifact@v3
         with:
-          path: docs
+          path: docs/.vitepress/dist
 
       - name: Deploy to GitHub Pages
         if: "!github.event.release.prerelease"

.gitignore

@@ -1,3 +1,7 @@
 node_modules/
 dist/
-docs/
+docs/api/
+docs/.vitepress/dist/
+docs/.vitepress/cache/
+coverage/
+html/

.idea/compiler.xml

@@ -1,48 +1,92 @@
 # @cldn/ip
 
-IP address utility.
+[![Documentation](https://img.shields.io/badge/Documentation-blue)](https://ip.cldn.pro)
+[![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github)](https://github.com/cloudnode-pro/ip)
+[![NPM](https://img.shields.io/npm/v/@cldn/ip.svg)](https://www.npmjs.com/package/@cldn/ip)
+[![Downloads](https://img.shields.io/npm/d18m/@cldn/ip.svg)](https://www.npmjs.com/package/@cldn/ip)
+[![Licence](https://img.shields.io/github/license/cloudnode-pro/ip)](https://github.com/cloudnode-pro/ip/blob/master/COPYING)
+[![CI](https://github.com/cloudnode-pro/ip/actions/workflows/ci.yml/badge.svg)](https://github.com/cloudnode-pro/ip/actions/workflows/ci.yml)
+![Coverage: 100%](https://img.shields.io/badge/coverage-100%25-brightgreen)
 
-## Features
+A modern, object-oriented TypeScript library for representing and performing arithmetic on IP addresses and subnets.
+
+[**Documentation — API Reference**](https://ip.cldn.pro)
 
-- Works in the browser and in Node.js without any polyfills. (A bundler like Webpack or Vite is recommended for the
-    browser)
-- IPv4 and IPv6 classes.
-- Get IP address as BigInt, binary or string.
-- Extract IPv4-mapped IPv6 addresses.
-- Subnet class with methods to check IP membership, create netmask, list addresses, etc.
-- Network class for working with multiple subnets.
-- Written in TypeScript.
+## Usage
 
-See the [**Documentation**](https://ip.cldn.pro)
+### Node.js
 
-## Installation
+Install with `npm`:
 
 ```sh
 npm install @cldn/ip
 ```
 
-## Usage
+Import and use:
 
 ```ts
 import {IPv4, IPv6, Subnet} from "@cldn/ip";
+```
+
+### Deno
 
-const ipv6 = IPv4.fromString("::ffff:192.168.1.42");
-const ipv4 = ipv6.getMappedIPv4();
+Import the package from npm using the standard prefix:
 
-const subnet = Subnet.fromString("192.168.0.0/16");
-subnet.has(ipv4); // true
+```ts
+import {IPv4, IPv6, Subnet} from "npm:@cldn/ip";
 ```
 
-## Licence
+### Browsers
+
+For browser usage, it is recommended to use a bundler like [Vite](https://vitejs.dev/),
+or [Webpack](https://webpack.js.org/). If you are using a bundler, follow the same usage as for Node.js.
+
+Alternatively, you can import the library as
+a [JavaScript module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
+from [ESM>CDN](https://esm.sh/):
+
+```html
+
+<script type="module">
+  import {IPv4, IPv6, Subnet} from "https://esm.sh/@cldn/ip";
+</script>
+```
 
-Copyright © 2024–2025 Cloudnode OÜ
+## Features
+
+- Object-oriented representation of IPv4 and IPv6 addresses, and subnets.
+- Comprehensive subnet arithmetic operations (e.g., containment, splitting, merging).
+- Support for CIDR notation for defining and parsing subnets.
+- Easy definition and manipulation of networks and collections of subnets.
+- Support for IPv4-mapped IPv6 addresses.
+- Fully documented, fully typed, and thoroughly tested with 100% coverage.
+- Zero dependencies; compatible with frontend and backend environments without requiring polyfills.
+
+## Example
+
+```ts
+import {IPv4, Subnet} from "@cldn/ip";
+
+// Parse IPv4 address
+const ip = IPv4.fromString("213.0.113.42");
+// Or use IPAddress.fromString("213.0.113.42") to parse either IPv4 or IPv6
+
+// Create subnet from CIDR notation
+const subnet = Subnet.fromCIDR("213.0.113.0/24");
 
-This file is part of @cldn/ip.
+// Check if IP is within subnet
+console.log(subnet.contains(ip)); // true
+```
+
+## Contact
+
+For bugs, or feature requests, please use [GitHub Issues](https://github.com/cloudnode-pro/ip/issues).
+
+For real-time chat or community discussions, join our Matrix
+space: [#community\:cloudnode.pro](https://matrix.to/#/%23community:cloudnode.pro).
+
+## Licence
 
-@cldn/ip is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
-Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
-later version.
+Copyright © 2024–2025 Cloudnode OÜ.
 
-@cldn/ip is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
-warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
-details.
+This project is licensed under the terms of the [LGPL-3.0](https://github.com/cloudnode-pro/ip/blob/master/COPYING) licence.

.idea/dictionaries/project.xml

@@ -0,0 +1,37 @@
+import {defineConfig} from "vitepress";
+import typedocSidebar from "../api/typedoc-sidebar.json";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+    title: "@cldn/ip",
+    description: "Documentation",
+    cleanUrls: true,
+    themeConfig: {
+        nav: [
+            {text: "API Reference", link: "/api/"},
+        ],
+
+        sidebar: [
+            {
+                text: "API",
+                items: typedocSidebar,
+            },
+        ],
+
+        outline: [2, 3],
+
+        socialLinks: [
+            {icon: "github", link: "https://github.com/cloudnode-pro/ip"},
+            {icon: "matrix", link: "https://matrix.to/#/@cloudnode:matrix.org"},
+        ],
+
+        search: {
+            provider: "local",
+        },
+
+        footer: {
+            copyright: `Copyright © 2024–2025 Cloudnode OÜ.`,
+            message: `Released under the <a href="https://github.com/cloudnode-pro/ip/blob/master/COPYING" target="_blank">LGPL-3.0</a> licence.`
+        }
+    },
+});

README.md

@@ -0,0 +1,26 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: "@cldn/ip"
+  text: "Documentation"
+  tagline: A modern, object-oriented TypeScript library for representing and performing arithmetic on IP addresses and subnets.
+  actions:
+    - theme: brand
+      text: API Reference
+      link: /api/
+
+features:
+  - title: Unified IP Types
+    details: Object-oriented classes for IPv4 and IPv6, with full support for IPv4-mapped IPv6 addresses.
+
+  - title: Subnet Logic
+    details: Perform checks, splits, merges, and other operations on CIDR-based subnets.
+
+  - title: Network Modelling
+    details: Build and work with networks and subnet sets using simple, composable tools.
+
+  - title: Typed and Minimal
+    details: Fully typed, thoroughly tested, and dependency-free. Works in any JS or TS environment.
+---