aheh/bit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: update README

Browse Source
This commit is contained in:
sjdonado
2025-11-02 11:40:50 +01:00
parent b8c1269d6e
commit 44dab3ca5a
2 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -2
View File
@@ -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. - 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. - 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). - 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? ## Why bit?
**Fast:** **11k req/sec**, latency 11ms, 40MiB avg memory usage (100k requests using 125 connections, [benchmark](docs/SETUP.md#benchmark)). **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). **Self-hosted:** [Dokku](docs/SETUP.md#dokku), [Docker Compose](docs/SETUP.md#docker-compose).
docs/openapi.yaml
+3 -5
View File
@@ -11,16 +11,14 @@ info:
## Authentication ## 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). 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: contact:
name: API Support name: Juan Rodriguez Donado
url: https://github.com/sjdonado/bit url: https://sjdonado.com
servers: servers:
- url: http://localhost:4000 - url: http://localhost:4000
description: Development server description: Development server
- url: http://localhost:4001
description: Benchmark server
security: security:
- ApiKeyAuth: [] - ApiKeyAuth: []