Skip to content

Commit caa3741

Browse files
bryant1410hootlex
authored andcommitted
Fix broken Markdown headings (#21)
1 parent 690b51c commit caa3741

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ A simple Moderation System for Laravel 5.* that allows you to Approve or Reject
33

44
Keep your application pure by preventing offensive, irrelevant, or insulting content.
55

6-
##Possible Use Case
6+
## Possible Use Case
77

88
1. User creates a resource (a post, a comment or any Eloquent Model).
99
2. The resource is pending and invisible in website (ex. `Post::all()` returns only approved posts).
@@ -15,7 +15,7 @@ Keep your application pure by preventing offensive, irrelevant, or insulting con
1515

1616
4. You application is clean.
1717

18-
##Installation
18+
## Installation
1919

2020
First, install the package through Composer.
2121

@@ -91,10 +91,10 @@ class AddModerationColumnsToPostsTable extends Migration
9191

9292
**You are ready to go!**
9393

94-
##Usage
94+
## Usage
9595
> **Note:** In next examples I will use Post model to demonstrate how the query builder works. You can Moderate any Eloquent Model, even User.
9696
97-
###Moderate Models
97+
### Moderate Models
9898
You can moderate a model Instance:
9999
```php
100100
$post->markApproved();
@@ -124,10 +124,10 @@ Post::where('title', 'Horse')->reject();
124124
Post::where('title', 'Horse')->postpone();
125125
```
126126

127-
###Query Models
127+
### Query Models
128128
By default only Approved models will be returned on queries. To change this behavior check the [configuration](#configuration).
129129

130-
#####To query the Approved Posts, run your queries as always.
130+
##### To query the Approved Posts, run your queries as always.
131131
```php
132132
//it will return all Approved Posts (strict mode)
133133
Post::all();
@@ -139,7 +139,7 @@ Post::approved()->get();
139139
Post::where('title', 'Horse')->get();
140140

141141
```
142-
#####Query pending or rejected models.
142+
##### Query pending or rejected models.
143143
```php
144144
//it will return all Pending Posts
145145
Post::pending()->get();
@@ -159,7 +159,7 @@ Post::withRejected()->get();
159159
//it will return Approved and Postponed Posts
160160
Post::withPostponed()->get();
161161
```
162-
#####Query ALL models
162+
##### Query ALL models
163163
```php
164164
//it will return all Posts
165165
Post::withAnyStatus()->get();
@@ -168,7 +168,7 @@ Post::withAnyStatus()->get();
168168
Post::withAnyStatus()->where('title', 'Horse')->get();
169169
```
170170

171-
###Model Status
171+
### Model Status
172172
To check the status of a model there are 3 helper methods which return a boolean value.
173173
```php
174174
//check if a model is pending
@@ -184,12 +184,12 @@ $post->isRejected();
184184
$post->isPostponed();
185185
```
186186

187-
##Strict Moderation
187+
## Strict Moderation
188188
Strict Moderation means that only Approved resource will be queried. To query Pending resources along with Approved you have to disable Strict Moderation. See how you can do this in the [configuration](#configuration).
189189

190-
##Configuration
190+
## Configuration
191191

192-
###Global Configuration
192+
### Global Configuration
193193
To configuration Moderation package globally you have to edit `config/moderation.php`.
194194
Inside `moderation.php` you can configure the following:
195195

@@ -198,7 +198,7 @@ Inside `moderation.php` you can configure the following:
198198
2. `moderated_by_column` represents the default column 'moderated_by' in the database.
199199
3. `strict` represents [*Strict Moderation*](#strict-moderation).
200200

201-
###Model Configuration
201+
### Model Configuration
202202
Inside your Model you can define some variables to overwrite **Global Settings**.
203203

204204
To overwrite `status` column define:

0 commit comments

Comments
 (0)