Merge pull request #16 from cybercog/feature/readme-and-license

Updated license info and readme

Author: Pe Ell

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to `laravel-eloquent-flag` will be documented in this file.
 
-## 3.0.0 - [Unreleased]
+## 3.0.0 - 2017-01-07
 
 ### Added
 
@@ -14,13 +14,13 @@ All notable changes to `laravel-eloquent-flag` will be documented in this file.
 
 - Each Flag trait was spliced on 2 additional traits: `Has{Name}Flag` = `Has{Name}FlagScope` + `Has{Name}FlagHelpers`.
 - Kept Flag trait was spliced on 3 additional traits, because events were pulled out to `HasKeptFlagBehavior` trait.
-- Flags `Classic\Accepted`, `Classic\Active` & `Classic\Approved` methods were changed. Details in the [UPGRADING.md](UPGRADING.md).
+- Flags `Classic\Accepted`, `Classic\Active` & `Classic\Approved` methods were changed. Details in the [Upgrade Guide](UPGRADE.md).
 
-## 2.1.0 - 2016-01-04
+## 2.1.0 - 2017-01-04
 
 - `is_closed` inverse boolean flag added.
 
-## 2.0.0 - 2016-01-04
+## 2.0.0 - 2017-01-04
 
 ### Breaking changes
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016, CyberCog LLC (http://cybercog.ru).
+Copyright (c) 2017, Anton Komarev <a.komarev@cybercog.su>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,13 +1,15 @@
-# Laravel Eloquent Flag
+![cog-laravel-eloquent-flag-3](https://cloud.githubusercontent.com/assets/1849174/21735581/feb857cc-d47b-11e6-80fa-126be1a1d871.png)
 
-[![Build Status](https://img.shields.io/travis/cybercog/laravel-eloquent-flag/master.svg?style=flat-square)](https://travis-ci.org/cybercog/laravel-eloquent-flag)
-[![StyleCI](https://styleci.io/repos/69245607/shield)](https://styleci.io/repos/69245607)
-[![Releases](https://img.shields.io/github/release/cybercog/laravel-eloquent-flag.svg?style=flat-square)](https://github.com/cybercog/laravel-eloquent-flag/releases)
-[![License](https://img.shields.io/github/license/cybercog/laravel-eloquent-flag.svg?style=flat-square)](https://github.com/cybercog/laravel-eloquent-flag/blob/master/LICENSE)
+<p align="center">
+<a href="https://travis-ci.org/cybercog/laravel-eloquent-flag"><img src="https://img.shields.io/travis/cybercog/laravel-eloquent-flag/master.svg?style=flat-square" alt="Build Status"></a>
+<a href="https://styleci.io/repos/69245607"><img src="https://styleci.io/repos/69245607/shield" alt="StyleCI"></a>
+<a href="https://github.com/cybercog/laravel-eloquent-flag/releases"><img src="https://img.shields.io/github/release/cybercog/laravel-eloquent-flag.svg?style=flat-square" alt="Releases"></a>
+<a href="https://github.com/cybercog/laravel-eloquent-flag/blob/master/LICENSE"><img src="https://img.shields.io/github/license/cybercog/laravel-eloquent-flag.svg?style=flat-square" alt="License"></a>
+</p>
 
-Eloquent flagged attributes behavior. Add commonly used flags to models very quick and easy.
+## Introduction
 
-![cog-laravel-eloquent-flag](https://cloud.githubusercontent.com/assets/1849174/21166452/b1bbf3e8-c1b6-11e6-8f06-468828402ebe.png)
+Eloquent flagged attributes behavior. Enhance eloquent models with commonly used flags like `Active`, `Published`, `Approved` and other in a minutes!
 
 ## Features
 
@@ -50,7 +52,7 @@ composer require cybercog/laravel-eloquent-flag
 
 And then include the service provider within `app/config/app.php`.
 
-*// Service provider not using yet. Will be used to boot console commands in future.*
+*// Service provider not using yet. This step not mandatory. Will be used to boot console commands in future.*
 
 ```php
 'providers' => [
@@ -515,7 +517,7 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ## Security
 
-If you discover any security related issues, please email support@cybercog.su instead of using the issue tracker.
+If you discover any security related issues, please email a.komarev@cybercog.su instead of using the issue tracker.
 
 ## Credits
 

UPGRADING.md UPGRADE.mdUPGRADING.md renamed to UPGRADE.md

@@ -1,6 +1,10 @@
-# Upgrading
+# Upgrade Guide
 
-## From v2 to v3
+- [Upgrading To 3.0 From 2.0](#upgrade-3.0)
+- [Upgrading To 2.0 From 1.0](#upgrade-2.0)
+
+<a name="upgrade-3.0"></a>
+## Upgrading To 3.0 From 2.0
 
 You can upgrade from v2 to v3 by performing these renames in your model that has flags: `Accepted`, `Active` & `Approved`.
 
@@ -18,7 +22,8 @@ These methods should be renamed:
 - `withoutUnapproved()` has been renamed to `withoutDisapproved()`.
 - `onlyUnapproved()` has been renamed to `onlyDisapproved()`.
 
-## From v1 to v2
+<a name="upgrade-2.0"></a>
+## Upgrading To 2.0 From 1.0
 
 - Namespaces of flag's traits received `Classic` at the end: `Cog\Flag\Traits\Classic`.
 - Namespaces of flag's scopes received `Classic` at the end: `Cog\Flag\Scopes\Classic`.

src/Providers/FlagServiceProvider.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of Laravel Eloquent Flag.
  *
- * (c) CyberCog <support@cybercog.su>
+ * (c) Anton Komarev <a.komarev@cybercog.su>
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.

src/Scopes/Classic/AcceptedFlagScope.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of Laravel Eloquent Flag.
  *
- * (c) CyberCog <support@cybercog.su>
+ * (c) Anton Komarev <a.komarev@cybercog.su>
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.

src/Scopes/Classic/ActiveFlagScope.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of Laravel Eloquent Flag.
  *
- * (c) CyberCog <support@cybercog.su>
+ * (c) Anton Komarev <a.komarev@cybercog.su>
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.

src/Scopes/Classic/ApprovedFlagScope.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of Laravel Eloquent Flag.
  *
- * (c) CyberCog <support@cybercog.su>
+ * (c) Anton Komarev <a.komarev@cybercog.su>
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.

src/Scopes/Classic/KeptFlagScope.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of Laravel Eloquent Flag.
  *
- * (c) CyberCog <support@cybercog.su>
+ * (c) Anton Komarev <a.komarev@cybercog.su>
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.

src/Scopes/Classic/PublishedFlagScope.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of Laravel Eloquent Flag.
  *
- * (c) CyberCog <support@cybercog.su>
+ * (c) Anton Komarev <a.komarev@cybercog.su>
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.