Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kjellberg authored Mar 25, 2024
1 parent c9d61be commit 4ed9d2b
Showing 1 changed file with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 [email protected]: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).

0 comments on commit 4ed9d2b

Please sign in to comment.