From 0ab065ea3e59bf121dc3a885285cd49d183e28f4 Mon Sep 17 00:00:00 2001
From: GHOSCHT <31184695+GHOSCHT@users.noreply.github.com>
Date: Sat, 21 Dec 2024 01:11:48 +0100
Subject: [PATCH] Add readme

---
 .forgejo/workflows/{rust.yml => build.yml} |  0
 README.md                                  | 16 ++++++++++++++++
 2 files changed, 16 insertions(+)
 rename .forgejo/workflows/{rust.yml => build.yml} (100%)
 create mode 100644 README.md

diff --git a/.forgejo/workflows/rust.yml b/.forgejo/workflows/build.yml
similarity index 100%
rename from .forgejo/workflows/rust.yml
rename to .forgejo/workflows/build.yml
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7ad5533
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# picoKontroller
+ [![ci/cd](https://git.ghoscht.com/ghoscht/picoKontroller/badges/workflows/build.yml/badge.svg?style=for-the-badge)](https://git.ghoscht.com/ghoscht/picoKontroller/actions?workflow=build.yml)
+ [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg?style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0)
+ [![built with nix](https://builtwithnix.org/badge.svg)](https://builtwithnix.org)
+ 
+ Control your Linux audio with a MIDI mixer like the KORG nanoKONTROL2. Supports PulseAudio or Pipewire via pipewire-pulse.
+
+## Features
+
+- **blazingly fast**: Rust go brrr
+- **support for regex**: dynamically specify MIDI and PulseAudio devices with regular expressions 
+- **wide range of clients**: supports PulseAudio, MPRIS and custom shell commands
+
+## See Also
+
+- [nanoKontroller](https://github.com/tpneill/nanoKontroller) - inspiration for this project, based on Python