Updated changelog and docs

MeirKriheli · Jul 30, 2024 · 86f8a31 · 86f8a31
1 parent c716746
commit 86f8a31
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 31 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -19,3 +19,4 @@ Contributors
 
 * Just van Rossum - https://github.com/justvanrossum
 * Jakub Wilk <[email protected]>
+* Christian Clauss <[email protected]>
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -3,6 +3,14 @@ Changelog
 
 .. :changelog:
 
+0.6.0
+-----
+
+* Added implemention selection (Python or Rust) to pybidi cli,
+  respecting backward comapt
+* Restored older algorithm, supports both implementations closes #25
+* Modernize and simplify Python code (Thanks Christian Clauss)
+
 0.5.2
 -----
 

diff --git a/docs/bidi.rst b/docs/bidi.rst
@@ -20,6 +20,22 @@ bidi.bidi module
    :undoc-members:
    :show-inheritance:
 
+bidi.mirror module
+------------------
+
+.. automodule:: bidi.mirror
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+bidi.wrapper module
+-------------------
+
+.. automodule:: bidi.wrapper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,37 +6,7 @@
 Welcome to Python BiDi's documentation!
 =======================================
 
-`Bi-directional`_ (BiDi) layout implementation in pure python.
-
-.. _Bi-directional: http://en.wikipedia.org/wiki/Bi-directional_text
-
-Installation
-------------
-
-At the command line (assuming you're using some virtualenv)::
-
-    pip install python-bidi
-
-
-Usage
---------
-
-To use Python BiDi in a project:
-
-.. code-block:: python
-
-    import bidi
-
-    some_string = "your string goes here"
-    result = bidi.get_display(some_string)
-
-
-Versions 0.5.1 and 0.5.2 adds compat for the older import path:
-
-.. code-block:: python
-
-    from bidi import get_display
-
+.. include:: ../README.rst
 
 Contents: