From 7d31c06a9fb05e2cd0a091216239d823cb3a2f73 Mon Sep 17 00:00:00 2001 From: Mathieu Broillet Date: Sun, 4 Aug 2024 18:43:40 +0200 Subject: [PATCH] update readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 1bee201..0f4e9af 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,12 @@ process images and return the license plate information found in the image while > [CodeProject AI](https://www.codeproject.com/AI/docs/index.html) but it has **one important restriction** with it's free version: > - The last character of the license plate is masked with an asterisk *(e.g. ``ABC1234`` -> ``ABC123*``)* +## Installation +Simply download the latest release from the [releases page](/releases) and run the executable. + +The following platforms are currently supported: +- **Linux** (x86_64) + ## Usage The server listens on port 5000 and has a few endpoints documented below, the most important one being [``/v1/image/alpr``](#v1visionalpr).