Version 2.6.0

.gitattributes

@@ -4,11 +4,11 @@
 # Do not put this files on a distribution package (by .gitignore)
 /vendor              export-ignore
 /build               export-ignore
-/wiki                export-ignore
 /composer.lock       export-ignore
+/node_modules        export-ignore
+/package-lock.json   export-ignore
 
 # Do not put this files on a distribution package
-/docs/               export-ignore
 /tests/              export-ignore
 /.gitattributes      export-ignore
 /.gitignore          export-ignore
@@ -18,3 +18,6 @@
 /.travis.yml         export-ignore
 /phpcs.xml.dist      export-ignore
 /phpunit.xml.dist    export-ignore
+/mkdocs.yml          export-ignore
+/.markdownlint.json  export-ignore
+

.gitignore

@@ -1,5 +1,7 @@
 # do not include this files on git
 /vendor
 /build
-/wiki
 /composer.lock
+/node_modules
+/package-lock.json
+

.markdownlint.json

@@ -0,0 +1,11 @@
+{
+  "line-length": false,
+  "no-inline-html": true,
+  "blank_lines": {
+      "maximum": 2
+  },
+  "no-trailing-punctuation": {
+      "punctuation": ".,;:"
+  }
+}
+

.travis.yml

@@ -6,6 +6,9 @@ php:
   - 7.1
   - 7.2
 
+before_install:
+  - nvm install 8
+
 # This triggers builds to run on the new TravisCI infrastructure.
 # See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
 sudo: false
@@ -20,6 +23,8 @@ env:
 
 before_script:
   - travis_retry composer install --no-interaction --prefer-dist
+  - travis_retry npm install
+  - travis_retry pip install --user mkdocs
   - phpenv config-rm xdebug.ini
 
 script:
@@ -34,6 +39,8 @@ script:
       vendor/bin/phpunit
     fi
   - vendor/bin/phpstan.phar --no-progress analyse --level max src/ tests/
+  - node node_modules/markdownlint-cli/markdownlint.js *.md docs/
+  - ~/.local/bin/mkdocs build --strict --site-dir build/docs
 
 after_script:
   # upload test covegare to scrutinizer

CODE_OF_CONDUCT.md

@@ -22,8 +22,8 @@ include:
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
+* The use of sexualized language or imagery and unwelcome sexual attention
+  or advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic

README.md

@@ -21,7 +21,7 @@ and is written in **spanish language** since is the language of the intented aud
 
 **Atención: este proyecto se migrará a `phpcfdi/cfdiutils`, aun no hay fecha planeada**
 
-## Main features:
+## Main features
 
 - Create CFDI version 3.3 based on a friendly extendable non-xml objects (`nodes`)
 - Read CFDI version 3.2 and 3.3
@@ -30,36 +30,32 @@ and is written in **spanish language** since is the language of the intented aud
   if not then the document was modified after signature.
 - Validate the "Complemento de recepción de pagos"
 - Helper objects to deal with:
-    - `Cadena de origen` generation
-    - Extract information from CER files or `Certificado` attribute
-    - Calculate `Comprobante` sums based on the list of `Conceptos`
-    - Retrieve the CFDI version information
+  - `Cadena de origen` generation
+  - Extract information from CER files or `Certificado` attribute
+  - Calculate `Comprobante` sums based on the list of `Conceptos`
+  - Retrieve the CFDI version information
 - Keep a local copy of the tree of XSD and XSLT file dependences from SAT
 - Keep a local copy of certificates to avoid download them each time
-- Check the SAT WebService to get the status of a CDI ('Activo', 'Cancelado' & 'No encontrado') 
+- Check the SAT WebService to get the status of a CDI ('Activo', 'Cancelado' & 'No encontrado')
 
 
 ## Installation
 
 Use [composer](https://getcomposer.org/), so please run
+
 ```shell
 composer require eclipxe/cfdiutils
 ```
 
 
 ## Major versions
 
-- Version 1.x **deprecated** was deprecated time ago, that version didn't do much anyway
-- Version 2.x **current** has a lot of features and helper objects
-- Version 3.x **future** will be released with the following backward compatibility breaks:
-    - Rename `\CfdiUtils\CadenaOrigen\CadenaOrigenBuilder` to `\CfdiUtils\CadenaOrigen\DOMBuilder`
-    - Rename `\CfdiUtils\CadenaOrigen\DefaultLocations` to `\CfdiUtils\CadenaOrigen\CfdiDefaultLocations`
-    - Remove `\CfdiUtils\CadenaOrigen\CadenaOrigenLocations`
-    - Remove `\CfdiUtils\PemPrivateKey\PemPrivateKey::isOpened` to `\CfdiUtils\PemPrivateKey\PemPrivateKey::isOpen`
-    - Remove `static` methods from `\CfdiUtils\CfdiVersion`, create an instance of the class  
-    - Remove `static` methods from `\CfdiUtils\TimbreFiscalDigital\TfdVersion`, create an instance of the class  
-
-It could be possible that version 3 will be migrated to a different project under the group [PhpCfdi]
+- Version 1.x **deprecated** was deprecated time ago, that version didn't do much anyway.
+- Version 2.x **current** has a lot of features and helper objects.
+- Version 3.x **future** will be released with backward compatibility breaks.
+  - See [docs/CHANGELOG.md](docs/CHANGELOG.md) for backward compatibility breaks.
+  - It may change to PHP 7.1
+  - It could be possible to migrate to phpcfdi/cfiutils under [phpCfdi](https://github.com/phpCfdi) organization
 
 
 ## PHP Support

composer.json

@@ -57,7 +57,8 @@
     "scripts": {
         "build": [
             "@fix-style",
-            "@qa"
+            "@qa",
+            "@docs"
         ],
         "check-style": [
             "vendor/bin/php-cs-fixer fix --dry-run --verbose",
@@ -71,6 +72,10 @@
             "vendor/bin/phpstan.phar analyse --no-progress --level max src/ tests/",
             "@test"
         ],
+        "docs": [
+            "node_modules/markdownlint-cli/markdownlint.js *.md docs/",
+            "mkdocs build --strict --site-dir build/docs"
+        ],
         "test": [
             "vendor/bin/phplint",
             "vendor/bin/phpunit"