Add a README

madewithlove · Nov 21, 2019 · 7d219b8 · 7d219b8
1 parent c21c26a
commit 7d219b8
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,17 @@
 # Laravel Nova: Uuid support
 
 This package adds support to Laravel Nova for resources and users that have string identifiers such as uuid's.
+
+### Usage
+
+Note that you should only use this package in Laravel Nova projects.
+
+```bash
+# install the package
+composer require madewithlove/laravel-nova-uuid-support
+
+# run your migrations
+php artisan migrate
+```
+
+That's it, your Laravel Nova installation can now handle entities and users with string identifiers.