From 0ffdf4d01a537212d946b9805ab03b6e20358c2a Mon Sep 17 00:00:00 2001 From: Andreas Farah Date: Wed, 20 Dec 2023 12:18:12 +0100 Subject: [PATCH] Update remdme --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 69b909a..f570565 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ![Kompass](https://github.com/secondnetwork/kompass/blob/main/public/assets/kompass_md.png?raw=true) [![Latest Kompass Version](https://img.shields.io/packagist/v/secondnetwork/kompass.svg?style=for-the-badge&label=Kompass&labelColor=FFA700&color=1A2A2C)](https://github.com/secondnetwork/kompass) -[![Laravel](https://img.shields.io/badge/v10.X-999999?style=for-the-badge&label=Laravel&labelColor=eb4432&color=1A2A2C)](https://laravel.com) +[![Laravel](https://img.shields.io/badge/v10.35-999999?style=for-the-badge&label=Laravel&labelColor=eb4432&color=1A2A2C)](https://laravel.com) [![PHP 8.1](https://img.shields.io/badge/v8.1-999999?style=for-the-badge&label=PHP&labelColor=777BB4&color=1A2A2C)](https://php.com) [![License](https://img.shields.io/github/license/secondnetwork/kompass?style=for-the-badge)](https://github.com/secondnetwork/kompass) @@ -22,19 +22,25 @@ But built with the power of Tailwind, Alpine.js, Laravel and Livewire. Additionally Kompass requires you to use - PHP 8.1 or newer -- Laravel 10.0 or newer +- Laravel 10.35 or newer - Laravel Fortify 1.16 or newer - Livewire 3.0 or newer - Tailwindcss 3.3 or newer ## Installation -You can install the package via composer: +Kompass is super easy to install. After creating your new Laravel application you can include Kompass. ```bash composer require secondnetwork/kompass ``` +With the command we install frontend asset, created new admin user and drop all tables from the database. + +```bash +php artisan kompass:install +``` + ## Documentation Documentation is available at https://kompass.secondnetwork.de