From 2f8376a5f900df5e042eed950a5525dfaac67b14 Mon Sep 17 00:00:00 2001
From: Olivers Vitins <o.vitins@resultium.io>
Date: Sun, 18 Feb 2024 17:10:28 +0200
Subject: [PATCH] docs(README): update info in README

---
 README.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index fdb7092..9870e0e 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-# svelte-headlessui
+# @resultium/svelte-headlessui
+
+This is a fork of Rgossiaux's svelte-headlessui made due to lack of maintainment of the initial package. This package is not published to any registries as it was never meant to be used anywhere outside Resultium projects, however you are free to use it as per MIT license.
 
 This is an unofficial, complete Svelte port of the Headless UI component library (https://headlessui.dev/). It contains **fully accessible, feature-rich, unstyled** UI components.
 
@@ -18,8 +20,16 @@ This project is an **unofficial** port. I have no affiliation with Tailwind Labs
 
 ## Installation
 
+```bash
+yarn add -D git+https://git.resultium.net/public/svelte-headlessui.git
 ```
-npm install -D @rgossiaux/svelte-headlessui
+
+```bash
+pnpm i -D git+https://git.resultium.net/public/svelte-headlessui.git
+```
+
+```bash
+npm i -D git+https://git.resultium.net/public/svelte-headlessui.git
 ```
 
 ## Usage