From b432d75bdeb869b2eb54453e713997b634068f40 Mon Sep 17 00:00:00 2001
From: Tobias <bvrcreepyx@hotmail.de>
Date: Sat, 12 Oct 2024 23:30:10 +0200
Subject: [PATCH] update readme

---
 README.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3621e34..98189d2 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,33 @@
-# pakku
\ No newline at end of file
+# pakku
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/mycreepy/pakku.svg)](https://pkg.go.dev/github.com/mycreepy/pakku)
+[![Go Report Card](https://goreportcard.com/badge/github.com/mycreepy/pakku?style=flat-square)](https://goreportcard.com/report/github.com/mycreepy/pakku)
+[![Go Build & Test](https://github.com/mycrEEpy/pakku/actions/workflows/build.yml/badge.svg)](https://github.com/mycrEEpy/pakku/actions/workflows/build.yml)
+
+`pakku` is a declarative approach to your system package managers.
+
+## Installation
+
+You can download the pre-built binaries from the GitHub Releases or use various other installation methods.
+
+Using Go:
+
+```shell
+go install github.com/mycreepy/pakku@latest
+```
+
+Using Pkgx:
+
+```shell
+pkgx install github.com/mycreepy/pakku
+```
+
+## Usage
+
+* Initialize a new config:
+  * `pakku init`
+* Add some packages to your config:
+  * `pakku add apt curl`
+  * `pakku add brew awscli`
+* Install the packages on your system:
+  * `pakku apply`