Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Adrián Pardellas Blunier committed Jun 17, 2016
1 parent f2154be commit 7f24b28
Showing 1 changed file with 5 additions and 48 deletions.
53 changes: 5 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit 7f24b28

Please sign in to comment.