:octocat:

README.md

@@ -1,12 +1,7 @@
 # chillerlan/php-qrcode
 
-A PHP QR Code generator based on the [implementation by Kazuhiko Arase](https://github.com/kazuhikoarase/qrcode-generator),
-namespaced, cleaned up, improved and other stuff. It also features a QR Code reader based on a [PHP port](https://github.com/khanamiryan/php-qrcode-detector-decoder) of the [ZXing library](https://github.com/zxing/zxing).
-
 **Hi! Please check out the [v5.0-beta release](https://github.com/chillerlan/php-qrcode/releases/tag/5.0-beta) and leave your feedback in [this discussion thread](https://github.com/chillerlan/php-qrcode/discussions/188). Thanks!**
 
-**Attention:** there is now also a javascript port: [chillerlan/js-qrcode](https://github.com/chillerlan/js-qrcode).
-
 [![PHP Version Support][php-badge]][php]
 [![Packagist version][packagist-badge]][packagist]
 [![Continuous Integration][gh-action-badge]][gh-action]
@@ -27,7 +22,16 @@ namespaced, cleaned up, improved and other stuff. It also features a QR Code rea
 [downloads-badge]: https://img.shields.io/packagist/dt/chillerlan/php-qrcode?logo=packagist
 [downloads]: https://packagist.org/packages/chillerlan/php-qrcode/stats
 
-## Features
+
+## Overview
+
+A PHP QR Code generator based on the [implementation by Kazuhiko Arase](https://github.com/kazuhikoarase/qrcode-generator), namespaced, cleaned up, improved and other stuff. <br>
+It also features a QR Code reader based on a [PHP port](https://github.com/khanamiryan/php-qrcode-detector-decoder) of the [ZXing library](https://github.com/zxing/zxing).
+
+
+**Attention:** there is now also a javascript port: [chillerlan/js-qrcode](https://github.com/chillerlan/js-qrcode).
+
+### Features
 
 - Creation of [Model 2 QR Codes](https://www.qrcode.com/en/codes/model12.html), [Version 1 to 40](https://www.qrcode.com/en/about/version.html)
 - [ECC Levels](https://www.qrcode.com/en/about/error_correction.html) L/M/Q/H supported
@@ -35,7 +39,9 @@ namespaced, cleaned up, improved and other stuff. It also features a QR Code rea
   - numeric
   - alphanumeric
   - 8-bit binary
-  - 13-bit double-byte kanji (Japanese, Shift-JIS) and hanzi (simplified Chinese, GB2312/GB18030) as [defined in GBT18284-2000](https://www.chinesestandard.net/PDF/English.aspx/GBT18284-2000)
+  - 13-bit double-byte:
+    - kanji (Japanese, Shift-JIS)
+    - hanzi (simplified Chinese, GB2312/GB18030) as [defined in GBT18284-2000](https://www.chinesestandard.net/PDF/English.aspx/GBT18284-2000)
 - Flexible, easily extensible output modules, built-in support for the following output formats:
   - [GdImage](https://www.php.net/manual/book.image)
   - [ImageMagick](https://www.php.net/manual/book.imagick)
@@ -45,13 +51,9 @@ namespaced, cleaned up, improved and other stuff. It also features a QR Code rea
   - PDF via [FPDF](https://github.com/setasign/fpdf)
 - QR Code reader (via GD and ImageMagick)
 
-## Documentation
-
-See [the wiki](https://github.com/chillerlan/php-qrcode/wiki) for advanced documentation.
-An API documentation created with [phpDocumentor](https://www.phpdoc.org/) can be found at https://chillerlan.github.io/php-qrcode/ (WIP).
-The documentation for `QROptions` container can be found here: [chillerlan/php-settings-container](https://github.com/chillerlan/php-settings-container#readme).
 
 ### Requirements
+
 - PHP 7.4+
   - [`ext-mbstring`](https://www.php.net/manual/book.mbstring.php)
   - optional:
@@ -62,14 +64,28 @@ The documentation for `QROptions` container can be found here: [chillerlan/php-s
 
 For the QRCode reader, either `ext-gd` or `ext-imagick` is required!
 
-### Installation
-**requires [composer](https://getcomposer.org)**
 
-via terminal:
+## Documentation
+
+- The user manual is at https://php-qrcode.readthedocs.io/ ([sources](https://github.com/chillerlan/php-qrcode/tree/main/docs))
+- An API documentation created with [phpDocumentor](https://www.phpdoc.org/) can be found at https://chillerlan.github.io/php-qrcode/
+- The documentation for `QROptions` container can be found here: [chillerlan/php-settings-container](https://github.com/chillerlan/php-settings-container#readme)
+
+
+## Installation with [composer](https://getcomposer.org)
+
+See [the installation guide](https://php-qrcode.readthedocs.io/en/main/Usage-Installation.html) for more info!
+
+
+### Terminal
+
 ```
 composer require chillerlan/php-qrcode
 ```
-via `composer.json`:
+
+
+### composer.json
+
 ```json
 {
 	"require": {
@@ -78,76 +94,75 @@ via `composer.json`:
 	}
 }
 ```
+
 Note: replace `dev-main` with a [version constraint](https://getcomposer.org/doc/articles/versions.md#writing-version-constraints), e.g. `^4.3` - see [releases](https://github.com/chillerlan/php-qrcode/releases) for valid versions.
-See [the installation guide on the wiki](https://github.com/chillerlan/php-qrcode/wiki/Installation) for more info!
 
-### Quickstart
+
+## Quickstart
+
 We want to encode this URI for a mobile authenticator into a QRcode image:
+
 ```php
 $data = 'otpauth://totp/test?secret=B3JX4VCVJDVNXNZ5&issuer=chillerlan.net';
 
 // quick and simple:
 echo '<img src="'.(new QRCode)->render($data).'" alt="QR Code" />';
 ```
+
+Wait, what was that? Please again, slower! See [Advanced usage](https://php-qrcode.readthedocs.io/en/main/Usage-Advanced-usage.html) in the manual.
+Also, have a look [in the examples folder](https://github.com/chillerlan/php-qrcode/tree/main/examples) for some more usage examples.
+
 <p align="center">
 	<img alt="QR codes are awesome!" style="width: auto; height: 530px;" src="https://raw.githubusercontent.com/chillerlan/php-qrcode/main/.github/images/example.svg">
 </p>
 
-Wait, what was that? Please again, slower! See [Advanced usage](https://github.com/chillerlan/php-qrcode/wiki/Advanced-usage) on the wiki.
-Also, have a look [in the examples folder](https://github.com/chillerlan/php-qrcode/tree/main/examples) for some more usage examples.
 
 ### Reading QR Codes
 
 Using the built-in QR Code reader is pretty straight-forward:
+
 ```php
-$result = (new QRCode)->readFromFile('path/to/file.png'); // -> DecoderResult
+// it's generally a good idea to wrap the reader in a try/catch block because it WILL throw eventually
+try{
+	$result = (new QRCode)->readFromFile('path/to/file.png'); // -> DecoderResult
 
-// you can now use the result instance...
-$content = $result->data;
-$matrix  = $result->getMatrix(); // -> QRMatrix
+	// you can now use the result instance...
+	$content = $result->data;
+	$matrix  = $result->getMatrix(); // -> QRMatrix
 
-// ...or simply cast it to string to get the content:
-$content = (string)$result;
+	// ...or simply cast it to string to get the content:
+	$content = (string)$result;
+}
+catch(Throwable $e){
+	// oopsies!
+}
 ```
-It's generally a good idea to wrap the reading in a try/catch block to handle any errors that may occur in the process.
-
-### Framework Integration
-- Drupal:
-  - [Two-factor Authentication `tfa`](https://www.drupal.org/project/tfa) (Drupal 8+)
-  - [Google Authenticator Login `ga_login`](https://www.drupal.org/project/ga_login) (deprecated, Drupal 7)
-- Symfony
-  - [phpqrcode-bundle](https://github.com/jonasarts/phpqrcode-bundle)
-- WordPress:
-  - [wp-two-factor-auth](https://github.com/sjinks/wp-two-factor-auth)
-  - [simple-2fa](https://wordpress.org/plugins/simple-2fa/)
-  - [floating-share-button](https://github.com/qriouslad/floating-share-button)
-- WoltLab Suite
-  - [two-step-verification](http://pluginstore.woltlab.com/file/3007-two-step-verification/)
-- other uses:
-  - [dependents](https://github.com/chillerlan/php-qrcode/network/dependents) / [packages](https://github.com/chillerlan/php-qrcode/network/dependents?dependent_type=PACKAGE)
-  - [Appwrite](https://github.com/appwrite/appwrite)
-  - [Cachet](https://github.com/CachetHQ/Cachet)
-  - [GÉANT CAT](https://github.com/GEANT/CAT)
-  - [openITCOCKPIT](https://github.com/it-novum/openITCOCKPIT)
-  - [twill](https://github.com/area17/twill)
-  - [Elefant CMS](https://github.com/jbroadway/elefant)
-- Articles:
-  - https://www.twilio.com/blog/create-qr-code-in-php (featuring v4.3.x)
-
-### Shameless advertising
-Hi, please check out my other projects that are way cooler than qrcodes!
 
-- [php-oauth-core](https://github.com/chillerlan/php-oauth-core) - an OAuth 1/2 client library along with a bunch of [providers](https://github.com/chillerlan/php-oauth-providers)
+
+## Shameless advertising
+
+Hi, please check out some of my other projects that are way cooler than qrcodes!
+
+- [js-qrcode](https://github.com/chillerlan/js-qrcode) - a javascript port of this library
+- [php-authenticator](https://github.com/chillerlan/php-authenticator) - a Google Authenticator implementation (see [authenticator example](https://github.com/chillerlan/php-qrcode/blob/main/examples/authenticator.php))
 - [php-httpinterface](https://github.com/chillerlan/php-httpinterface) - a PSR-7/15/17/18 implemetation
+- [php-oauth-core](https://github.com/chillerlan/php-oauth-core) - an OAuth 1/2 client library along with a bunch of [providers](https://github.com/chillerlan/php-oauth-providers)
 - [php-database](https://github.com/chillerlan/php-database) - a database client & querybuilder for MySQL, Postgres, SQLite, MSSQL, Firebird
+- [php-tootbot](https://github.com/php-tootbot/tootbot-template) - a Mastodon bot library (see [@dwil](https://github.com/php-tootbot/dwil))
+
+
+## Disclaimer!
 
-### Disclaimer!
 I don't take responsibility for molten CPUs, misled applications, failed log-ins etc.. Use at your own risk!
 
-#### License notice
-Parts of this code are [ported to PHP](https://github.com/codemasher/php-qrcode-decoder) from the [ZXing project](https://github.com/zxing/zxing) and licensed under the [Apache License, Version 2.0](./NOTICE).
 
-#### Trademark Notice
+### License notice
+
+- Parts of this code are [ported to PHP](https://github.com/codemasher/php-qrcode-decoder) from the [ZXing project](https://github.com/zxing/zxing) and licensed under the [Apache License, Version 2.0](./NOTICE).
+- [The documentation](https://github.com/chillerlan/php-qrcode/tree/main/docs) is licensed under the [Creative Commons Attribution 4.0 International (CC BY 4.0) License](https://creativecommons.org/licenses/by/4.0/).
+
+
+### Trademark Notice
 
 The word "QR Code" is a registered trademark of *DENSO WAVE INCORPORATED*<br>
 https://www.qrcode.com/en/faq.html#patentH2Title