chore: update README
This commit is contained in:
@@ -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).
|
||||
|
||||
|
||||
+3
-5
@@ -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: []
|
||||
|
||||
Reference in New Issue
Block a user