From 3df4642c903ba68c3ef44bd0cdf8b988d33e4e57 Mon Sep 17 00:00:00 2001 From: sjdonado Date: Thu, 20 Mar 2025 20:50:53 +0100 Subject: [PATCH] chore: update README --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 803d25e..7cd2a8a 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,18 @@ [![Docker Stars](https://img.shields.io/docker/stars/sjdonado/bit.svg)](https://hub.docker.com/r/sjdonado/bit) [![Docker Image Size](https://img.shields.io/docker/image-size/sjdonado/bit/latest)](https://hub.docker.com/r/sjdonado/bit) -Lightweight URL shortener API service with minimal resource requirements. Average memory consumption is under **30MiB** and single CPU core consumption around 30%. - -Performance: Avg **1K reqs/sec**, latency 30ms, [benchmark](docs/SETUP.md#benchmark). +Lightweight URL shortener (API-only) with minimal resource requirements. Avg memory consumption under pressure is **60MiB**, single CPU core consumption around 30% (1K reqs/sec, latency 30ms, [benchmark](docs/SETUP.md#benchmark)). Self-hosted with [Dokku](docs/SETUP.md#dokku) and [Docker Compose](docs/SETUP.md#docker-compose). Images available on [Docker Hub](https://hub.docker.com/r/sjdonado/bit/tags). ## Why bit? -It is feature-complete by design. Its strength lies in simplicity, reliable without unnecessary bloat. Bug fixes will continue, but new features aren't planned. +It is feature-complete by design: simple and reliable without unnecessary bloat. Bug fixes will continue, but new features aren't planned. -- 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. -- Standard `X-Forwarded-For` headers pass client context, enabling tracking and integration capabilities. -- Multiple users are supported via API key authentication. Create, list and delete via the [CLI](docs/SETUP.md#cli). +- 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. +- Provides standard `X-Forwarded-For` header support to enable extended capabilities. +- Multiple users are supported via API key authentication. Users can create, list and delete keys via the [CLI](docs/SETUP.md#cli). ## Minimum Requirements - 100MB disk space