Documented support for Bun and CI tests on Bun (#161)

Author: zefir-git

.github/workflows/ci.yml

@@ -76,7 +76,7 @@ jobs:
         run: tar -xzf cldn-ip-0.0.0-dev.tgz --strip-components=1 -C . --overwrite
 
       - name: Test
-        run: npm run test
+        run: npm run test:coverage
 
   test-deno:
     name: Test on Deno
@@ -98,13 +98,32 @@ jobs:
         run: deno fmt --check
 
       - name: Test
-        run: deno task test
+        run: deno task test:coverage
+
+  test-bun:
+    name: Test on Bun
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Run tests
+        run: bun run test
 
   publish:
     name: Publish
     needs:
       - test
       - test-deno
+      - test-bun
     if: github.event_name == 'release'
     runs-on: ubuntu-latest
     permissions:

.idea/runConfigurations/test.xml .idea/runConfigurations/test_coverage.xml.idea/runConfigurations/test.xml renamed to .idea/runConfigurations/test_coverage.xml

@@ -15,29 +15,22 @@ arithmetic on IP addresses and subnets.
 
 ## Usage
 
-### Node.js
+### Installation
 
-Install from NPM:
+Install the package using your preferred environment:
 
 ```sh
+# Node.js
 npm install @cldn/ip
-```
-
-Import and use:
-
-```ts
-import { IPv4, IPv6, Subnet } from "@cldn/ip";
-```
-
-### Deno
-
-Add from JSR:
 
-```sh
+# Deno
 deno add jsr:@cldn/ip
+
+# Bun
+bun install @cldn/ip
 ```
 
-Import and use:
+### Import
 
 ```ts
 import { IPv4, IPv6, Subnet } from "@cldn/ip";
@@ -46,10 +39,10 @@ import { IPv4, IPv6, Subnet } from "@cldn/ip";
 ### 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.
+[Vite](https://vitejs.dev/) or [Webpack](https://webpack.js.org/). If using a
+bundler, import as above.
 
-Alternatively, you can import the library as a
+Alternatively, load as a
 [JavaScript module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
 from [ESM>CDN](https://esm.sh/):
 

README.md

@@ -13,7 +13,8 @@
   ],
   "scripts": {
     "build": "tsc",
-    "test": "vitest run --coverage",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
     "docs:gen": "typedoc && rm -rf docs/api && mv api docs/api",
     "predocs:dev": "npm run docs:gen",
     "docs:dev": "vitepress dev docs",