diff --git a/README.md b/README.md index 3c1fe11f..a51dff88 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,20 @@ -Crud View -========= +[![Build Status](https://img.shields.io/travis/FriendsOfCake/crud-view/master.svg?style=flat-square)](https://travis-ci.org/FriendsOfCake/crud-view) +[![Coverage Status](https://img.shields.io/coveralls/FriendsOfCake/crud-view.svg?style=flat-square)](https://coveralls.io/r/FriendsOfCake/crud-view?branch=master) +[![Total Downloads](https://img.shields.io/packagist/dt/FriendsOfCake/crud-view.svg?style=flat-square)](https://packagist.org/packages/FriendsOfCake/crud-view) +[![Latest Stable Version](https://img.shields.io/packagist/v/FriendsOfCake/crud-view.svg?style=flat-square)](https://packagist.org/packages/FriendsOfCake/crud-view) +[![Documentation Status](https://readthedocs.org/projects/crud-view/badge/?version=latest&style=flat-square)](https://readthedocs.org/projects/crud-view/?badge=latest) + +# Crud View Automated admin backend based on your Crud configuration. This project is in early stage of development, do not use it production unless you want to get down and dirty on the code :) -Documentation -============= +## Documentation + You can find the WIP detailed usage documentation [here](http://crud-view.readthedocs.org/en/latest/). -Quick Start -=========== +### Quick Start 1) Install the plugin using `composer require --prefer-dist friendsofcake/crud-view:dev-master`. @@ -24,8 +28,7 @@ Quick Start 6) Hopefully going to ``/