Skip to content

Commit

Permalink
Updating the readme examples.
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisThompsonTLDR committed Jul 26, 2018
1 parent 51578d7 commit 7a32257
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Laraman - Laravel Data Manager

Laraman is a Laravel based package designed to help being able review data quickly.
Laraman is a Laravel based administration panel.

Laraman provides a quick user interface for reviewing and managing data stored in your database.

Laraman is really good at the index route, searching, filtering and pagination. It leaves the create, update and delete to the application.

Expand Down Expand Up @@ -89,10 +91,10 @@ and then use it
use LaramanController;
```

Laraman expects your controller to have a `__construct()` method where a few things are configured.
Laraman expects your controller to have a `__configure()` method where a few things are configured.

```
public function __construct()
public function __configure()
{
$this->columns = [
[
Expand Down Expand Up @@ -125,7 +127,7 @@ This example will build an index route with a table with 4 columns and 1 button.
If the model name you want to use doesn't make the naming convention you used for your controller, it can be set with the model attribute

```
public function __construct()
public function __configure()
{
$this->model = \App\Mail::class;
```
Expand All @@ -135,7 +137,7 @@ If the model name you want to use doesn't make the naming convention you used fo
Need to load views from another path, use the `viewPath` attribute

```
public function __construct()
public function __configure()
{
$this->viewPath = config('laraman.view.hintpath') . '::mail';
```
Expand All @@ -145,7 +147,7 @@ Need to load views from another path, use the `viewPath` attribute
The route where laraman lives for this controller can be changed

```
public function __construct()
public function __configure()
{
$this->routePath = config('laraman.route.prefix') . '.mail';
```
Expand All @@ -155,7 +157,7 @@ The route where laraman lives for this controller can be changed
You can enable model level searches with the `searchEnabled` attribute

```
public function __construct()
public function __configure()
{
$this->searchEnabled = true;
```
Expand All @@ -175,7 +177,7 @@ The only required array key for a column is the `field`. This will be the datab
The dot notation can be used to reach related model data.

```
public function __construct()
public function __configure()
{
$this->columns = [
[
Expand All @@ -201,7 +203,7 @@ public function __construct()
If you need to use a custom blade for a field, define it like this

```
public function __construct()
public function __configure()
{
$this->columns = [
[
Expand All @@ -218,7 +220,7 @@ public function __construct()
Laraman can have defined filters that users will be able to use

```
public function __construct()
public function __configure()
{
$this->filters = [
[
Expand Down Expand Up @@ -248,7 +250,7 @@ public function __construct()
Action buttons can be added with the `buttons` attribute

```
public function __construct()
public function __configure()
{
$this->buttons = [
'laraman::buttons.braintree-transaction',
Expand Down Expand Up @@ -281,7 +283,7 @@ class TrialController extends Controller
{
use LaramanController;
public function __construct()
public function __configure()
{
$this->columns = [
[
Expand Down

0 comments on commit 7a32257

Please sign in to comment.