add initial readme

26B · Jul 13, 2022 · 4feb105 · 4feb105
1 parent 9ff4489
commit 4feb105
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# Laravel Permissions
+
+Livewire component to manage permissions for a given model. 
+
+⚠️ This library is in active development so the API may suffer changes.
+
+Requires:
+
+- Livewire
+- AlpineJS
+- Backstate
+
+## Getting started
+
+Require the package
+
+```
+composer require 26b/laravel-permissions
+```