Use readme for documentation for now

.gitignore

@@ -1,3 +1,4 @@
 /.idea
+/docs/build
 /vendor
 /composer.lock

README.md

@@ -35,6 +35,7 @@ The library is compatible with `ext-random` as released in PHP 8.2.0 beta 1.
 
 ## TODO
 
+* Tests & CI
 * `Random\Randomizer`
   * `getBytes($length)`
   * `shuffleArray($array)`
@@ -51,6 +52,7 @@ The library is compatible with `ext-random` as released in PHP 8.2.0 beta 1.
 ## License
 
 The library is available as open source under the terms of the [3-Clause BSD License].
-See `COPYING.adoc` for additional licenses.
+See [COPYING.adoc][COPYING] for additional licenses.
 
 [3-Clause BSD License]: https://opensource.org/licenses/BSD-3-Clause
+[COPYING]: COPYING.adoc

docs/_templates/sidebar/brand.html

@@ -0,0 +1,22 @@
+<a class="sidebar-brand{% if logo %} centered{% endif %}" href="{{ pathto(master_doc) }}">
+    {% block brand_content %}
+    {%- if logo_url %}
+    <div class="sidebar-logo-container">
+        <img class="sidebar-logo" src="{{ logo_url }}" alt="Logo"/>
+    </div>
+    {%- endif %}
+    {%- if theme_light_logo and theme_dark_logo %}
+    <div class="sidebar-logo-container">
+        <img class="sidebar-logo only-light" src="{{ pathto('_static/' + theme_light_logo, 1) }}" alt="Light Logo"/>
+        <img class="sidebar-logo only-dark" src="{{ pathto('_static/' + theme_dark_logo, 1) }}" alt="Dark Logo"/>
+    </div>
+    {%- endif %}
+    {% if not theme_sidebar_hide_name %}
+    <span class="sidebar-brand-text">{{ docstitle if docstitle else project }}</span>
+    {%- endif %}
+    {% endblock brand_content %}
+</a>
+
+{%- if current_version -%}
+    <div class="sidebar-brand">{{ current_version }}</div>
+{%- endif -%}

docs/conf.py

@@ -0,0 +1,10 @@
+from datetime import datetime
+
+project = 'Random Extension Polyfill'
+author = 'Anton Smirnov'
+copyright = '{} {}'.format(datetime.now().year, author)
+language = 'en'
+
+html_title = project
+html_theme = 'furo'
+templates_path = ["_templates"]

docs/index.rst

@@ -0,0 +1,78 @@
+Random Extension Polyfill
+#########################
+
+|Packagist| |GitLab| |GitHub| |Bitbucket| |Gitea|
+
+This is a polyfill for the new ``ext-random`` extension that will be released with PHP 8.2.
+
+RFC:
+
+* https://wiki.php.net/rfc/rng_extension
+* https://wiki.php.net/rfc/random_extension_improvement
+
+Requirements
+============
+
+* PHP 7.1
+* GMP extension
+
+Installation
+============
+
+.. code-block:: bash
+
+    composer require 'arokettu/random-polyfill'
+
+Compatibility
+=============
+
+The library is compatible with ``ext-random`` as released in PHP 8.2.0 beta 1.
+
+What works
+==========
+
+* ``Random\Randomizer``
+  * ``getInt($min, $max)``
+  * ``getInt()``
+* Engines
+  * ``Random\Engine`` interface
+  * ``Random\CryptoSafeEngine`` interface
+  * Secure Engine: ``Random\Engine\Secure``
+  * Mersenne Twister: ``Random\Engine\Mt19937``
+
+TODO
+====
+
+* Tests & CI
+* ``Random\Randomizer``
+  * ``getBytes($length)``
+  * ``shuffleArray($array)``
+  * ``shuffleBytes($bytes)``
+  * ``pickArrayKeys($array, $num)``
+* Keep updating with fixes from the upcoming betas and release 1.0.0 around PHP 8.2.0 rc 1
+* Empty ``arokettu/random-polyfill`` v1.99 for PHP 8.2.0 users
+* Other engines
+  * Maybe
+  * Some day
+  * If I have time
+  * Don't count on it
+
+License
+=======
+
+The library is available as open source under the terms of the `3-Clause BSD License`__.
+See `COPYING.adoc`__ for additional licenses.
+
+.. __: https://opensource.org/licenses/BSD-3-Clause
+.. __: https://gitlab.com/sandfox/php-random-polyfill/-/blob/master/COPYING.adoc
+
+.. |Packagist|  image:: https://img.shields.io/packagist/v/arokettu/random-polyfill.svg?style=flat-square
+   :target:     https://packagist.org/packages/arokettu/random-polyfill
+.. |GitHub|     image:: https://img.shields.io/badge/get%20on-GitHub-informational.svg?style=flat-square&logo=github
+   :target:     https://github.com/arokettu/php-random-polyfill
+.. |GitLab|     image:: https://img.shields.io/badge/get%20on-GitLab-informational.svg?style=flat-square&logo=gitlab
+   :target:     https://gitlab.com/sandfox/php-random-polyfill
+.. |Bitbucket|  image:: https://img.shields.io/badge/get%20on-Bitbucket-informational.svg?style=flat-square&logo=bitbucket
+   :target:     https://bitbucket.org/sandfox/php-random-polyfill
+.. |Gitea|      image:: https://img.shields.io/badge/get%20on-Gitea-informational.svg?style=flat-square&logo=gitea
+   :target:     https://sandfox.org/sandfox/php-random-polyfill

docs/requirements.txt

@@ -0,0 +1 @@
+furo