Skip to content

Commit

Permalink
Adjustments to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Einar-Johan Hansen committed Oct 20, 2019
1 parent b97fb05 commit 4330c9f
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,17 @@ The `->withPlaceholderCount()` method lets you show the item number when adding
The `->logUsers()` method allows you to save which user created or completed the task/item. You specify which column on the User model you want to save on task, it default to use the "name" column.


![Checklist-form-page](form-add.png)
![Checklist-form-page](https://raw.githubusercontent.com/e2-consult/novachecklists/master/form-add.png)

You can edit an existing item by clicking on it.

![Checklist-form-page](form-edit.png)
![Checklist-form-page](https://raw.githubusercontent.com/e2-consult/novachecklists/master/form-edit.png)

### Detail-page

The `->showTimestamps()` method lets you show how long ago a task was completed.

![Checklist-detail-page](detail.png)
![Checklist-detail-page](https://raw.githubusercontent.com/e2-consult/novachecklists/master/detail.png)

### Index-page
By default this package will only show the task count on the index page.
Expand All @@ -61,7 +61,19 @@ The `->showItemStatusOnIndex()` will change the index to show how many tasks are

The `->showCompletionOnIndex()` method will let you show how many percent of the tasks are completed.

![Checklist-detail-page](index.png)
![Checklist-detail-page](https://raw.githubusercontent.com/e2-consult/novachecklists/master/index.png)

```php
use E2Consult\NovaChecklist\Checklist;

Checklist::make('Tasks')
->placeholder('Add task ')
->withPlaceholderCount()
->logUsers()
->showTimestamps()
->showItemStatusOnIndex()
->showCompletionOnIndex(),
```

## License

Expand Down

0 comments on commit 4330c9f

Please sign in to comment.