From 85dca0f0cb6e6685d42e2ae9238f2638f38fd258 Mon Sep 17 00:00:00 2001 From: Wiktor Zykubek Date: Fri, 27 Dec 2024 15:30:16 +0100 Subject: [PATCH] docs: update README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index bee7c13..6c25ad7 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,18 @@ To list available templates run: ```bash licensmith --list ``` + +## Installation +There are different ways to get Licensmith: +1. Use prebuilt binaries: + - [Releases](/wzykubek/licensmith/releases): Stable versions + - [Actions](/wzykubek/licensmith/actions): Development versions + +2. Install from source: [see *Compilation*](#compilation) + +## Compilation +```bash +git clone https://github.com/wzykubek/licensmith +cd licensmith +go build -v ./... +```