From 55969b03b55733d3ba3417f479eea968c3eb2832 Mon Sep 17 00:00:00 2001 From: sjdonado Date: Fri, 7 Feb 2025 17:30:10 +0100 Subject: [PATCH] chore: fix docs broken links --- CONTRIBUTING.md | 2 +- README.md | 2 +- docs/SETUP.md | 6 ++++-- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41cf8b6..098d985 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -107,4 +107,4 @@ For feature requests: - Suggest potential implementations ## License -By contributing, you agree that your contributions will be licensed under the project's [license](LICENSE.md). +By contributing, you agree that your contributions will be licensed under the [license](LICENSE). diff --git a/README.md b/README.md index 88aec72..28dc28c 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Lightweight URL shortener service with minimal resource requirements. Average memory consumption is **20MB RAM** with container disk space under **50MB**. -Bit is fast, see the [benchmark](docs/SETUP.md#benchmark) +Bit is highly performant, achieving over 850 requests per second with an average latency of just 118ms. For detailed benchmark results, see [benchmark](docs/SETUP.md#benchmark). ## Quick Start ```bash diff --git a/docs/SETUP.md b/docs/SETUP.md index 95d3a2c..d8636fc 100644 --- a/docs/SETUP.md +++ b/docs/SETUP.md @@ -3,8 +3,8 @@ ``` Usage: ./cli [options] Options: - --create-user=NAME Create a new user with the given name - --list-users List all users + --create-user=NAME Create a new user with the given name + --list-users List all users --delete-user=USER_ID Delete a user by ID ``` @@ -62,6 +62,8 @@ dokku ports:add bit https:443:4000 ## Benchmark +Conducted on a MacBook Air M2 with 16GB RAM. + ``` $ ./benchmark.sh Setting up...