Update README.md

Signed-off-by: Jan Tytgat <jan.tytgat@corelayer.eu>
2025-01-13 17:12:57 +01:00
parent 8e6c4cf2a8
commit 68fcee7425
1 changed files with 23 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,23 @@
-# go-transcrypt
+# 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
+```