diff --git a/.gitignore b/.gitignore index b817577..76a548d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,17 @@ -/.idea +composer.phar /vendor + /node_modules package-lock.json -composer.phar -composer.lock + phpunit.xml -.phpunit.result.cache +.phpunit.* +phpdox.xml + +/.idea + .DS_Store Thumbs.db + +composer.lock +auth.json \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8b5e32b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,27 @@ +# Contributing + +Contributions via Pull Requests are welcome and will be fully credited. + +## Pull Requests + +1. Fork the project. + +1. `git clone` it and `composer install` the dependencies. + +1. Create a feature branch. + +1. Make the changes you are proposing. + +1. Make sure the `README.md` and any other relevant documentation is kept up to date. + +1. Make sure each individual commit in your pull request is meaningful. If you made multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. + +1. Push to your fork. + +1. Open a pull request detailing your changes. **NB: One pull request per feature.** + +## Testing + +``` bash +$ phpunit +``` \ No newline at end of file diff --git a/README.md b/README.md index d952c2d..aa13f55 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ # Laravel Nova Enum Field +[![Latest Version](https://img.shields.io/github/release/simplesquid/nova-enum-field.svg?style=flat-square)](https://github.com/simplesquid/nova-vend/releases) +[![MIT Licensed](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE) +[![Total Downloads](https://img.shields.io/packagist/dt/simplesquid/nova-enum-field.svg?style=flat-square)](https://packagist.org/packages/simplesquid/nova-vend) + A Laravel Nova field for Enums from bensampo/laravel-enum. -## Installation +Contributions, issues and suggestions are very much welcome. -To use this package, you need a Laravel installation with [Nova](https://nova.laravel.com). +## Installation -**Composer** +To use this package, you need a Laravel installation with [Nova](https://nova.laravel.com). Then run: ```bash composer require simplesquid/nova-enum-field diff --git a/composer.json b/composer.json index 41dc949..8fadff7 100644 --- a/composer.json +++ b/composer.json @@ -16,8 +16,20 @@ } ], "require": { - "php": ">=7.1.0" + "php": "^7.3", + "laravel/nova": "^2.0", + "illuminate/support": "^5.8|^6.0", + "bensampo/laravel-enum": "^1.26" }, + "require-dev": { + "orchestra/testbench": "^3.8|^4.0" + }, + "repositories": [ + { + "type": "composer", + "url": "https://nova.laravel.com" + } + ], "autoload": { "psr-4": { "SimpleSquid\\Nova\\Fields\\Enum\\": "src/"