From 7f24b28c4d680d6b4183ad0631c6450d73638b5f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Pardellas=20Blunier?= Date: Fri, 17 Jun 2016 11:40:38 +0200 Subject: [PATCH] updated readme --- README.md | 53 +++++------------------------------------------------ 1 file changed, 5 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index 8afcd35..880e626 100644 --- a/README.md +++ b/README.md @@ -3,57 +3,14 @@ Anavel CRUD automates the Create, Read, Update and Delete tasks over your Larave > **Note:** This package is in active development and NOT ready for production. -### Features +## Official Documentation -* CRUD operations over Eloquent models. -* Search, pagination and sorting. +Documentation for Anavel CRUD module can be found on the [Anavel website](http://anavel.anavallasuiza.com/docs/master/crud). -### Requirements. +## Contributing -* PHP 5.4 or higher. -* Laravel 5. -* [Anavel foundation](https://github.com/anavel/foundation). - -## Instalation - -To use this package you must first install [Anavel foundation](https://github.com/anavel/foundation). This package was conceived as an Anavel module. - -With Anavel installed and working, require this package with composer: - -``` -composer require anavel/crud -``` - -After updating composer, add the ModuleProvider to the modules array in anavel config: - -``` -Anavel\Crud\CrudModuleProvider::class -``` - -Copy the package config to your local config with the publish command: - -``` -php artisan vendor:publish -``` - -## Configuration - -To start CRUDing your models just add them to the config file as follows: - -``` -... -'models' => [ - 'Users' => App\User::class, - 'Blog Posts' => App\Post::class -... -``` - -And that's all! TA-DÁ! You will find a full-featured CRUD on you admin panel. - -## Documentation - -Visit the [wiki](https://github.com/anavel/crud/wiki) for more detailed information on how to customize your configuration based CRUD. +Thank you for considering contributing to the Anavel Laravel CMS! The contribution guide can be found in the [Anavel documentation](http://anavel.anavallasuiza.com/docs/master/foundation/contributions). ## License -This software is published under the MIT License +Anavel is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).