Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mateusjatenee committed May 23, 2017
1 parent b97fe9d commit 1ac67d4
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
LaravelJsonFeed
PHP Json Feed
================
[![Build Status](https://travis-ci.org/mateusjatenee/laravel-json-feed.svg?branch=master)](https://travis-ci.org/mateusjatenee/laravel-json-feed)
[![Latest Stable Version](https://poser.pugx.org/mateusjatenee/laravel-json-feed/v/stable)](https://packagist.org/packages/mateusjatenee/laravel-json-feed)
Expand Down Expand Up @@ -33,7 +33,9 @@ And on the `aliases` array, register the facade:
```

#### Usage
The library is really simple to use and actually does not depend on Laravel itself, though it allows you to use a config file (not yet). It automatically filters formats the JSON and removes any unnecessary property.
The library is really simple to use and actually does not depend on Laravel itself, though it allows you to use a config file (not yet). It automatically filters formats the JSON and removes any unnecessary property.

If you're not using Laravel, [jump to this part](#all-at-once).

How to use it? Let's take the following JSON as an example:
```json
Expand Down Expand Up @@ -126,7 +128,8 @@ class JsonFeedController extends Controller

```

Alternatively, you may do all at once.
# All at once
Alternatively, you may do all at once, specially if you are not using Laravel.

```php
<?php
Expand Down

0 comments on commit 1ac67d4

Please sign in to comment.