From 4ed9d2b41c1b7891b467aea3ed6236389f8a52c5 Mon Sep 17 00:00:00 2001
From: Rasmus Kjellberg <2277443+kjellberg@users.noreply.github.com>
Date: Mon, 25 Mar 2024 18:39:28 +0100
Subject: [PATCH] docs: update README.md

---
 README.md | 39 ++++++++++++++++++++++++++-------------
 1 file changed, 26 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 7db80e4..93efb02 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,37 @@
-# README
+KIQR
+----
+Turbocharge your SaaS journey with our ready-to-roll saas starter kit.
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+Dive straight into the SaaS game with KIQR—a powerhouse packed with everything you need to launch your project. Built on Rails 7.1.2.4 and styled with Tailwind CSS, it's the kickstart your idea needs, minus the setup hassle.
 
-Things you may want to cover:
+**Key highlights:**
 
-* Ruby version
+- ⭐ Secure user login/out with Devise
+- ⭐ Flexible team and personal account setups, streamlining the onboarding process
 
-* System dependencies
+## Getting started
 
-* Configuration
+To get started with **KIQR**, follow these simple steps:
 
-* Database creation
+#### 1. Clone the repository
 
-* Database initialization
+```console
+git clone git@github.com:kiqr/kiqr.git my-app
+```
 
-* How to run the test suite
+#### 2. Run the setup script
 
-* Services (job queues, cache servers, search engines, etc.)
+Navigate into the new directory (```cd my-app```) and run:
 
-* Deployment instructions
+```console
+bin/setup
+```
 
-* ...
+#### 3. Start the development environment
+```console
+bin/dev
+```
+
+License
+-------
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).