From 41b597dfc076634f7d93af46c3081194123ce648 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Th=C3=A9o=20Barnouin?= <theo.barnouin@protonmail.com>
Date: Wed, 13 Nov 2024 16:52:03 +0100
Subject: [PATCH] Update README

---
 README.md | 39 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 38 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c9ee930..fede1af 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,44 @@ Join the discussion on [Matrix](https://matrix.to/#/#spot-devel:matrix.org).
 
 ## Installing
 
-<a href='https://flathub.org/apps/details/dev.alextren.Spot'><img width='130' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-en.png'/></a>
+This is a fork from [stevenleadbeater/spot](https://github.com/stevenleadbeater/spot/tree/development) that aim to provide a nix package with working spotify OAuth.
+
+You can build the rust package with :
+
+```
+nix develop
+meson target -Dbuildtype=debug -Doffline=false --prefix="$HOME/.local"
+ninja install -C target
+# to run test/linter/etc
+meson test -C target  --verbose
+```
+
+You can use this flake in your own config with :
+
+```
+{
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable";
+
+    spot = {
+      url = "git+https://git.le43.eu/tbarnouin/spot";
+    };
+  };
+
+    outputs = { nixpkgs, spot, ...}:
+    let
+      system = "x86_64-linux";
+
+      pkgs = import nixpkgs {
+        inherit system;
+        overlays = [
+          spot.overlay
+        ];
+      };
+    in
+    {
+      ...snip
+```
 
 ## Usage notes