Skip to content

Commit

Permalink
installation info
Browse files Browse the repository at this point in the history
  • Loading branch information
mateusjatenee committed May 22, 2017
1 parent 099d206 commit 4a1914b
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,23 @@ This library provides a way to generate [JSON feeds](https://jsonfeed.org), a fo
$ composer require mateusjatenee/laravel-json-feed
```

#### Laravel Installation

On your `config/app.php` file, register the service provider:
```php
'providers' => [
...
Mateusjatenee\JsonFeed\JsonFeedServiceProvider::class,
];
```
And on the `aliases` array, register the facade:
```php
'aliases' => [
...
'JsonFeed' => Mateusjatenee\JsonFeed\Facades\JsonFeed::class,
];
```

#### 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.

Expand Down

0 comments on commit 4a1914b

Please sign in to comment.