From db5066120f9f9967e3dc81b3cb8274d85bda3874 Mon Sep 17 00:00:00 2001
From: Kazuya Takei <myself@attakei.net>
Date: Fri, 3 May 2024 16:25:45 +0900
Subject: [PATCH] doc: Update readme for release

---
 README.rst    | 39 +++++++++++++++++++++++++++++++++++++++
 README_ja.rst |  3 ---
 2 files changed, 39 insertions(+), 3 deletions(-)

diff --git a/README.rst b/README.rst
index 33b1115..adebfe5 100644
--- a/README.rst
+++ b/README.rst
@@ -2,6 +2,16 @@
 rst-budoux
 ==========
 
+.. list-table::
+
+   * - Badges
+     - .. image:: https://img.shields.io/pypi/v/rst-budoux.svg
+          :target: https://pypi.org/project/rst-budoux/
+     - .. image:: https://github.com/attakei-lab/rst-budoux/actions/workflows/main.yml/badge.svg
+          :target: https://github.com/attakei-lab/rst-budoux/actions
+     - .. image:: https://readthedocs.org/projects/rst-budoux/badge/?version=stable
+          :target: https://rst-budoux.readthedocs.io/en/sable
+
 Text splitter in reStructuredText by BudouX.
 
 .. raw:: html
@@ -14,9 +24,38 @@ Text splitter in reStructuredText by BudouX.
 
    `日本語での説明があります。 <https://github.com/attakei-lab/rst-budoux/blob/main/README_ja.rst> `_
 
+Overview
+========
+
+This is bridge library to ``docutils`` and ``budoux``.
+You can break lines naturally when build contents from reStructuredText by using this.
+
+See `document <https://rst-budoux.readthedocs.io/>`_ for more information.
+
+Usage
+=====
+
+You can install from PyPI.
+
+.. code:: console
+
+   pip install rst-budoux
+
+This provides also as Sphinx-extension, therefore it works to register into your ``conf.py``.
+
+.. code:: python
+
+   extensions = [
+       "rst_budoux.sphinx",
+   ]
+
+You want to use wihout Sphinx ? Please see `document <https://rst-budoux.readthedocs.io/>`_.
+
 Example
 =======
 
+This is example using psuedoxml outputs for "docutils only" and "with rst-budoux".
+
 .. code:: rst
 
    Example from BudouX
diff --git a/README_ja.rst b/README_ja.rst
index 89d7a87..1989e6c 100644
--- a/README_ja.rst
+++ b/README_ja.rst
@@ -72,8 +72,6 @@ docutilsの ``rst2pseudoxml`` を使うと、内部ではこのような構成
 使い方
 ======
 
-.. note:: ここは予定を書いています。
-
 インストール
 ------------
 
@@ -107,7 +105,6 @@ Sphinxを経由しての利用例
       "rst_budoux.sphinx",
    ]
 
-   budoux_html_separator = "<wbr>"
    buxoux_html_append_style = """
        body {
            word-break: keep-all;