[n/a] remove docs folder, add .gitattributes update README and CHANGELOG

.gitattributes

@@ -0,0 +1,11 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.travis.yml        export-ignore
+/phpunit.xml.dist   export-ignore
+/.scrutinizer.yml   export-ignore
+/tests              export-ignore
+/docs               export-ignore

CHANGELOG.md

@@ -0,0 +1,13 @@
+# CHANGELOG
+
+The Fcm library follows [SemVer](http://semver.org/).
+
+## 2.x
+
+Version `2.x` of this library is a full rewrite to be compliant with [HTTP v1 API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages). If you are on Legacy HTTP API, then you should consider using version `1.x`
+
+- 2.0.0 (2018-09)
+    - Rewrite library to be compatible with [HTTP v1 API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages)
+    - Improve tests
+    - Refactor code
+    - Move documentation to the [Wiki](https://github.com/ker0x/fcm/wiki) section of the repo

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016 Romain Monteil
+Copyright (c) 2016-2018 Romain Monteil
 
 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

@@ -26,34 +26,23 @@
 
 A PHP libray to send push notification with [Firebase Cloud Messaging](https://firebase.google.com/docs/cloud-messaging/)
 
-## Installation
-
-To install this library, simply run `composer require kerox/fcm`
+## Warning
 
-## Documentation
+Version `2.x` of this library is a full rewrite to be compliant with [HTTP v1 API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages). If you are on Legacy HTTP API, then you should consider using version `1.x`
 
-The documentation is available [here](http://fcm.readthedocs.org/en/latest/)
+## Installation
 
-## License
+You can install Fcm using Composer:
 
-The MIT License (MIT)
+```
+composer require kerox/fcm
+```
 
-Copyright (c) 2018 Romain Monteil
+You will then need to:
+* run `composer install` to get these dependencies added to your vendor directory
+* add the autoloader to your application with this line: `require('vendor/autoload.php');`
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+## Documentation
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+The documentation is available [here](http://fcm.readthedocs.org/en/latest/)

composer.json

@@ -13,7 +13,7 @@
   "authors": [
     {
       "name": "Romain Monteil",
-      "homepage": "http://kerox.fr",
+      "homepage": "https://kerox.fr",
       "email": "monteil.romain@gmail.com",
       "role": "Author"
     }