Documentation

tituskeuler · Sep 1, 2018 · c851be1 · c851be1
1 parent e4921cb
commit c851be1
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,30 @@
+# Laravel Nova Checkboxes Field
+
+![Checkboxes in Laravel Nova](formPreview.png)
+
+![Checkboxes in Laravel Nova](detailPreview.png)
+
+![Checkboxes in Laravel Nova](indexPreview.png)
+
+## Installation
+
+`composer require silvanite/novafieldcheckboxes`
+
+## Usage
+
+```php
+use Silvanite\NovaFieldCheckboxes\Checkboxes;
+
+Checkboxes::make('Permissions')->options([
+    'viewNova' => 'Access Admin UI',
+    'manageUsers' => 'Manage Users',
+]),
+```
+
+## Support
+
+If you require any support please contact me on [Twitter](https://twitter.com/m2de_io) or open an issue on this repository.
+
+## License
+
+MIT
diff --git a/detailPreview.png b/detailPreview.png
diff --git a/formPreview.png b/formPreview.png
diff --git a/indexPreview.png b/indexPreview.png
diff --git a/package.json b/package.json
@@ -1,4 +1,6 @@
 {
+    "name": "@silvanite/novafieldcheckboxes",
+    "version": "1.0.0",
     "private": true,
     "scripts": {
         "dev": "npm run development",