Updating misc files

arcanedev-maroc · arcanedev-maroc · commit 350c87764e5d · 2017-01-31T14:00:51.000Z
diff --git a/.gitattributes b/.gitattributes
@@ -1,7 +1,12 @@
+* text=auto
+
+/.github          export-ignore
+/_docs            export-ignore
 /tests            export-ignore
-/.editorconfig    export-ignore
-/.gitattributes   export-ignore
-/.gitignore       export-ignore
-/.scrutinizer.yml export-ignore
-/.travis.yml      export-ignore
-/phpunit.xml      export-ignore
+.editorconfig     export-ignore
+.gitattributes    export-ignore
+.gitignore        export-ignore
+.scrutinizer.yml  export-ignore
+.travis.yml       export-ignore
+phpunit.xml       export-ignore
+CONTRIBUTING.md   export-ignore
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,7 @@
+- Spam Blocker Version: #.#.#
+- Laravel Version: #.#.#
+- PHP Version: #.#.#
+
+### Description:
+
+### Steps To Reproduce:
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 ARCANEDEV - Spam Blocker
+Copyright (c) 2016-2017 ARCANEDEV - Spam Blocker
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -16,10 +16,9 @@ Spam Blocker is a package that allows you to block referral spammers.
 
 ## Table of contents
 
-1. [Requirements](_docs/1.Requirements.md)
-2. [Installation and Setup](_docs/2.Installation-and-Setup.md)
-3. [Configuration](_docs/3.Configuration.md)
-4. [Usage](_docs/4.Usage.md)
+  1. [Installation and Setup](_docs/1.Installation-and-Setup.md)
+  2. [Configuration](_docs/2.Configuration.md)
+  3. [Usage](_docs/3.Usage.md)
 
 ### Features
 
diff --git a/_docs/0.Home.md b/_docs/0.Home.md
@@ -7,12 +7,11 @@ Spam Blocker is a package that allows you to block referral spammers.
   * Easy setup &amp; configuration.
   * Well documented &amp; IDE Friendly.
   * Well tested with maximum code quality.
-  * Laravel `5.1 | 5.2` are supported.
+  * Laravel `5.1 | 5.2 | 5.3` are supported.
   * Made with :heart: &amp; :coffee:.
 
 ## Table of contents
 
-1. [Requirements](1-Requirements.md)
-2. [Installation and Setup](2-Installation-and-Setup.md)
-3. [Configuration](3-Configuration.md)
-4. [Usage](4-Usage.md)
+  1. [Installation and Setup](1.Installation-and-Setup.md)
+  2. [Configuration](2.Configuration.md)
+  3. [Usage](3.Usage.md)
diff --git a/_docs/1.Installation-and-Setup.md b/_docs/1.Installation-and-Setup.md
@@ -0,0 +1,69 @@
+# 1. Installation
+
+## Table of contents
+
+  1. [Installation and Setup](1.Installation-and-Setup.md)
+  2. [Configuration](2.Configuration.md)
+  3. [Usage](3.Usage.md)
+
+## Server Requirements
+
+The Spam Blocker package has a few system requirements:
+
+```
+- PHP >= 5.6.4
+```
+
+## Version Compatibility
+
+| Spam Blocker                               | Laravel                                                                                                             |
+|:-------------------------------------------|:------------------------------------------------------------------------------------------------------------        |
+| ![Spam Blocker v1.1.x][spam_blocker_1_2_x] | ![Laravel v5.0][laravel_5_0] ![Laravel v5.1][laravel_5_1] ![Laravel v5.2][laravel_5_2] ![Laravel v5.3][laravel_5_3] |
+| ![Spam Blocker v1.2.x][spam_blocker_1_3_x] | ![Laravel v5.4][laravel_5_4]                                                                                        |
+
+[laravel_5_0]:  https://img.shields.io/badge/v5.0-supported-brightgreen.svg?style=flat-square "Laravel v5.0"
+[laravel_5_1]:  https://img.shields.io/badge/v5.1-supported-brightgreen.svg?style=flat-square "Laravel v5.1"
+[laravel_5_2]:  https://img.shields.io/badge/v5.2-supported-brightgreen.svg?style=flat-square "Laravel v5.2"
+[laravel_5_3]:  https://img.shields.io/badge/v5.3-supported-brightgreen.svg?style=flat-square "Laravel v5.3"
+[laravel_5_4]:  https://img.shields.io/badge/v5.4-supported-brightgreen.svg?style=flat-square "Laravel v5.4"
+
+[spam_blocker_1_2_x]: https://img.shields.io/badge/version-1.2.*-blue.svg?style=flat-square "Spam Blocker v1.2.*"
+[spam_blocker_1_3_x]: https://img.shields.io/badge/version-1.3.*-blue.svg?style=flat-square "Spam Blocker v1.3.*"
+
+## Composer
+
+You can install this package via [Composer](http://getcomposer.org/) by running this command: `composer require arcanedev/spam-blocker`.
+
+## Laravel
+
+### Setup
+
+Once the package is installed, you can register the service provider in `config/app.php` in the `providers` array:
+
+```php
+// config/app.php
+
+'providers' => [
+    ...
+    Arcanedev\SpamBlocker\SpamBlockerServiceProvider::class,
+],
+```
+
+(**Optional**) And for the Facades:
+
+```php
+// config/app.php
+
+'aliases' => [
+    ...
+    'SpamBlocker' => Arcanedev\SpamBlocker\Facades\SpamBlocker::class,
+];
+```
+
+### Artisan commands
+
+To publish the config file, run this command:
+
+```bash
+php artisan vendor:publish --provider="Arcanedev\SpamBlocker\SpamBlockerServiceProvider"
+```
diff --git a/_docs/1.Requirements.md b/_docs/1.Requirements.md
diff --git a/_docs/2.Configuration.md b/_docs/2.Configuration.md
@@ -0,0 +1,3 @@
+# 2. Configuration
+
+### Coming Soon&hellip;
diff --git a/_docs/2.Installation-and-Setup.md b/_docs/2.Installation-and-Setup.md
diff --git a/_docs/3.Configuration.md b/_docs/3.Configuration.md
diff --git a/_docs/3.Usage.md b/_docs/3.Usage.md
@@ -0,0 +1,3 @@
+# 3. Usage
+
+### Coming Soon&hellip;
diff --git a/_docs/4.Usage.md b/_docs/4.Usage.md

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# 2. Configuration`
	`2`	`+`
	`3`	`+### Coming Soon…`