From e220d67fe3e7905e6222feb58a6474b7e389f886 Mon Sep 17 00:00:00 2001 From: meeg_leeto Date: Sat, 30 Apr 2022 02:53:06 +0100 Subject: [PATCH] doc: more info on README about what it is --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 8d600a4..1b3e43a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,18 @@ A very simple link shortener, written in Rust, made to self host. +## What is lonk + +Lonk provides an HTTP interface where you input a URL, and get a short, standardized URL +(`.../l/` plus a sequence of letters and numbers) that will redirect you to the provided +URL. + +Such link shorteners can be useful to share links where copy-pasting is not an option, or +undesirable. + +By default, links shortened with lonk expire after 3 days; this period can be refreshed by +resubmitting the URL, without changing the shortened URL. + ## Serving lonk `lonk` can be served with `docker-compose` (recommended) or as a binary.