Complete ATOM specs, adding missing properties. Source code filly validate PHPStan level 7. 100% code coverage.

Author: Damien Debin

.travis.yml

@@ -13,4 +13,5 @@ install:
   - travis_retry composer install --no-progress --no-interaction --prefer-dist
 script:
   - ./vendor/bin/php-cs-fixer fix --allow-risky=yes --dry-run -v --stop-on-violation
+  - ./vendor/bin/phpstan analyse -l 7 -c phpstan.neon src
   - composer phpunit

README.md

@@ -1,5 +1,44 @@
 [![Build Status](https://travis-ci.org/ddebin/atom-generator.svg?branch=master)](https://travis-ci.org/ddebin/atom-generator)
 
-# atom-generator
+# Atom feed generator
 
-Atom feed generator
+This library is an [Atom](https://en.wikipedia.org/wiki/Atom_(Web_standard) feed generator, PHP 7.1+, fully typed ([PHPStan](https://github.com/phpstan/phpstan) level 7, 100% code coverage). Follows W3C standard
+([RFC 4287](https://validator.w3.org/feed/docs/rfc4287.html)).
+
+## Installing
+
+To include `mc-google-visualization` in your project, add it to your `composer.json` file:
+
+```json
+{
+    "require": {
+        "ddebin/atom-generator": "^0.1"
+    }
+}
+```
+
+## Example
+
+```php
+<?php
+
+include_once 'vendor/autoload.php';
+
+$feed = new AtomGenerator\Feed();
+$feed->setTitle('Blog');
+$feed->setUpdatedDateTime(new DateTime('now'));
+
+$entry = new AtomGenerator\Entry();
+$entry->setTitle('Post', 'text');
+$entry->setId('tag:id');
+$entry->setContent('Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.', 'text');
+$entry->setUpdatedDateTime(new DateTime('2019-05-04T21:00:40Z'));
+
+$feed->addEntry($entry);
+
+echo $feed->saveXML();
+```
+
+## Validation
+
+A validation tool is included with static method `Feed::validate`. It uses a [Relax NG](https://en.wikipedia.org/wiki/RELAX_NG) schema coming from <https://validator.w3.org/feed/docs/rfc4287.html#schema> (inspired by <https://cweiske.de/tagebuch/atom-validation.htm>).

composer.json

@@ -21,7 +21,9 @@
   },
   "require-dev": {
     "friendsofphp/php-cs-fixer": "^2.15",
-    "phpunit/phpunit": "^7"
+    "phpunit/phpunit": "^7",
+    "phpstan/phpstan-strict-rules": "^0.11.1",
+    "phpstan/phpstan-webmozart-assert": "^0.11.2"
   },
   "config": {
     "platform": {
@@ -35,11 +37,12 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "Tests\\": "tests"
+      "Tests\\": "tests/"
     }
   },
   "scripts": {
-    "test": "./vendor/bin/php-cs-fixer fix --allow-risky=yes && ./vendor/bin/phpunit",
+    "test": "./vendor/bin/php-cs-fixer fix --allow-risky=yes && ./vendor/bin/phpstan analyse -l 7 -c phpstan.neon src tests && ./vendor/bin/phpunit",
+    "phpstan": "./vendor/bin/phpstan analyse -l 7 -c phpstan.neon src tests",
     "phpunit": "./vendor/bin/phpunit"
   }
 }