Skip to content

Commit 9080693

Browse files
committed
Expand docs index page
1 parent ea1f2f0 commit 9080693

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

docs/index.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,46 @@
66
[![StyleCI](https://styleci.io/repos/82349568/shield?branch=master)](https://styleci.io/repos/82349568)
77
[![TravisCI](https://travis-ci.org/DuckThom/laravel-importer.svg?branch=master)](https://travis-ci.org/DuckThom/laravel-importer)
88
[![License](https://poser.pugx.org/luna/laravel-importer/license)](https://packagist.org/packages/luna/laravel-importer)
9+
10+
## Prerequisites
11+
12+
- PHP 7.0 or 7.1
13+
- Laravel 5.4
14+
15+
## Installation
16+
17+
To install this package, run:
18+
```
19+
composer require luna/laravel-importer
20+
```
21+
22+
## Setup
23+
24+
Add the service provider and facade to `config/app.php`:
25+
```php
26+
'providers' => [
27+
// ...
28+
// Package providers
29+
30+
Luna\Importer\ServiceProvider::class,
31+
],
32+
33+
'aliases' => [
34+
// ...
35+
36+
"Import" => Luna\Importer\ImporterFacade::class
37+
]
38+
```
39+
40+
Publish the configuration:
41+
```
42+
php artisan vendor:publish --provider="Luna\Importer\ServiceProvider"
43+
```
44+
45+
## Contributing
46+
47+
1. Fork `https://github.com/DuckThom/laravel-importer`
48+
2. Run `composer install`
49+
3. Make changes
50+
4. Add tests if possible
51+
5. Push and create a PR

0 commit comments

Comments
 (0)