From 44dab3ca5a7d95835fcfad54a094daa0290a2453 Mon Sep 17 00:00:00 2001 From: sjdonado Date: Sun, 2 Nov 2025 11:40:50 +0100 Subject: [PATCH] chore: update README --- README.md | 5 +++-- docs/openapi.yaml | 8 +++----- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6bfcac2..fa38fb7 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,14 @@ - Minimal tracking setup: Country, browser, OS, referer. No cookies or persistent tracking mechanisms are used beyond what's available from a basic client's request. - Includes `X-Forwarded-For` header. - Multiple users are supported via API key authentication. Create, list and delete keys via the [CLI](docs/SETUP.md#cli). -- Easy to extend, Ruby on Rails-inspired setup. +- Easy to extend, Ruby on Rails inspired setup. +- Auto update UA regexes and GeoLite2 database ## Why bit? **Fast:** **11k req/sec**, latency 11ms, 40MiB avg memory usage (100k requests using 125 connections, [benchmark](docs/SETUP.md#benchmark)). -**Lightweight:** <100MB disk space, <100MiB RAM. +**Lightweight:** Minimal dependencies, image size under 20 MiB, memory usage under 60 MiB at peak. **Self-hosted:** [Dokku](docs/SETUP.md#dokku), [Docker Compose](docs/SETUP.md#docker-compose). diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 7a1c946..bc70f5b 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -11,16 +11,14 @@ info: ## Authentication Multiple users are supported via `X-Api-Key` headers. Create, list and delete keys via the [CLI](https://github.com/sjdonado/bit/blob/master/SETUP.md#cli). - version: 1.0.0 + version: 1.6.0 contact: - name: API Support - url: https://github.com/sjdonado/bit + name: Juan Rodriguez Donado + url: https://sjdonado.com servers: - url: http://localhost:4000 description: Development server - - url: http://localhost:4001 - description: Benchmark server security: - ApiKeyAuth: []