Skip to content

Commit

Permalink
Merge pull request #14 from ARCANEDEV/path-docs
Browse files Browse the repository at this point in the history
Updating the README.md and docs
  • Loading branch information
arcanedev-maroc authored Jul 24, 2016
2 parents 2912e58 + 6fc6025 commit 774a0ea
Show file tree
Hide file tree
Showing 8 changed files with 254 additions and 98 deletions.
13 changes: 3 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Feel free to check out the [releases](https://github.com/ARCANEDEV/SEO-Helper/re
* Easy setup & configuration.
* Well documented & IDE Friendly.
* Well tested with maximum code quality.
* Laravel 5.1 supported.
* Laravel `5.0 | 5.1 | 5.2` are supported.
* Made with :heart: & :coffee:.

## Table of contents
Expand All @@ -38,16 +38,9 @@ Feel free to check out the [releases](https://github.com/ARCANEDEV/SEO-Helper/re
5. [API](_docs/5-API.md)
6. [Extras](_docs/6-Extras.md)

## DONE
## TODO

- [x] Framework agnostic package.
- [x] Open Graph supported.
- [x] Twitter Cards supported.
- [x] Webmaster tools supported.
- [x] Google Analytics supported.
- [x] Laravel 5.2 supported.
- [x] Laravel 5.1 supported.
- [x] Laravel 5.0 supported.
- [ ] Laravel 5.3 support.

## Contribution

Expand Down
7 changes: 6 additions & 1 deletion _docs/0-Home.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# SEO Helper

SEO Helper is a package for Laravel 5 that provides tools and helpers for SEO.
SEO Helper is a package that provides tools and helpers for SEO (Search Engine Optimization).

### Features

* Framework agnostic package.
* Open Graph & Twitter Cards are supported.
* Webmaster tools site verifier tags are supported.
* Google Analytics tracking is supported.
* Easy setup & configuration.
* Well documented & IDE Friendly.
* Well tested with maximum code quality.
* Laravel `5.0 | 5.1 | 5.2` are supported.
* Made with :heart: & :coffee:.

## Table of contents
Expand Down
10 changes: 10 additions & 0 deletions _docs/1-Requirements.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# 1. Requirements

## Table of contents

0. [Home](0-Home.md)
1. [Requirements](1-Requirements.md)
2. [Installation and Setup](2-Installation-and-Setup.md)
3. [Configuration](3-Configuration.md)
4. [Usage](4-Usage.md)
5. [API](5-API.md)
6. [Extras](6-Extras.md)

## Server Requirements

The SEO Helper package has a few system requirements:
Expand Down
12 changes: 11 additions & 1 deletion _docs/2-Installation-and-Setup.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# 2. Installation

## Table of contents

0. [Home](0-Home.md)
1. [Requirements](1-Requirements.md)
2. [Installation and Setup](2-Installation-and-Setup.md)
3. [Configuration](3-Configuration.md)
4. [Usage](4-Usage.md)
5. [API](5-API.md)
6. [Extras](6-Extras.md)

## Composer

You can install this package via [Composer](http://getcomposer.org/) by running this command: `composer require arcanedev/seo-helper`.
Expand Down Expand Up @@ -31,7 +41,7 @@ Once the package is installed, you can register the service provider in `config/
],
```

And for the Facades:
(**Optional**) And for the Facades:

```php
// config/app.php
Expand Down
51 changes: 30 additions & 21 deletions _docs/3-Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,21 @@
## Table of contents

* [Title](#title)
* [Description](#description)
* [Keywords](#keywords)
* [Miscellaneous](#miscellaneous)
* [Webmaster Tools](#webmaster-tools)
* [Analytics](#analytics)
* [Open Graph](#open-graph)
* [Twitter](#twitter)
0. [Home](0-Home.md)
1. [Requirements](1-Requirements.md)
2. [Installation and Setup](2-Installation-and-Setup.md)
3. [Configuration](3-Configuration.md)
* [Title](#title)
* [Description](#description)
* [Keywords](#keywords)
* [Miscellaneous](#miscellaneous)
* [Webmaster Tools](#webmaster-tools)
* [Open Graph](#open-graph)
* [Twitter](#twitter)
* [Analytics](#analytics)
4. [Usage](4-Usage.md)
5. [API](5-API.md)
6. [Extras](6-Extras.md)

After you've published the config file `config/seo-helper.php`, you can customize the settings :

Expand Down Expand Up @@ -72,18 +79,11 @@ After you've published the config file `config/seo-helper.php`, you can customiz
],
```

### Analytics

```php
'analytics' => [
'google' => '', // UA-XXXXXXXX-X
],
```

### Open Graph

```php
'open-graph' => [
'enabled' => true,
'prefix' => 'og:',
'type' => 'website',
'title' => 'Default Open Graph title',
Expand All @@ -99,12 +99,21 @@ After you've published the config file `config/seo-helper.php`, you can customiz

```php
'twitter' => [
'prefix' => 'twitter:',
'card' => 'summary',
'site' => 'Username',
'title' => 'Default Twitter Card title',
'metas' => [
'enabled' => true,
'prefix' => 'twitter:',
'card' => 'summary',
'site' => 'Username',
'title' => 'Default Twitter Card title',
'metas' => [
//
],
],
```

### Analytics

```php
'analytics' => [
'google' => '', // UA-XXXXXXXX-X
],
```
Loading

0 comments on commit 774a0ea

Please sign in to comment.