From 68fcee7425dc08969f45343aa29a0e39484a813a Mon Sep 17 00:00:00 2001
From: Jan Tytgat <jan.tytgat@corelayer.eu>
Date: Mon, 13 Jan 2025 17:12:57 +0100
Subject: [PATCH] Update README.md

Signed-off-by: Jan Tytgat <jan.tytgat@corelayer.eu>
---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c68374a..0369041 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,23 @@
-# go-transcrypt
\ No newline at end of file
+# go-transcrypt
+
+This library enables the encryption/decryption of arbitrary data into a hex-encoded string for safe on-disk storage.
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/jantytgat/go-transcrypt.svg)](https://pkg.go.dev/github.com/jantytgat/go-transcrypt)
+
+---
+
+## Basics
+
+### Add the package to your project
+
+```bash
+go get github.com/jantytgat/go-transcrypt
+```
+
+### Import
+
+Next, you can manually add the import statement to your ```.go```-file, or have it added automatically when using it.
+
+```text
+import github.com/jantytgat/go-transcrypt
+```
\ No newline at end of file