release: Bump version 0.0.0 -> 0.1.0

atsphinx · May 28, 2023 · 247f636 · 247f636
1 parent 44f4014
commit 247f636
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 5 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -2,9 +2,11 @@
 Change logs
 ===========
 
-v0.0.0
+v0.1.0
 ======
 
-:date: 2023-05-01
+:date: 2023-05-29 JST
 
 Initial commit.
+
+* Collect articles included ``og-article`` directive and generate feed file.
diff --git a/README.rst b/README.rst
@@ -4,9 +4,38 @@ atsphinx-feed
 
 Simple RSS feed generator based Open Graph.
 
+Oviewview
+=========
+
+Sphinx extension to add RSS feed of documents.
+
+This is using ``atsphin-og-article``, and pick documents included ``og-article`` directive.
+You can select only documents that you want to notify as RSS.
+
 Getting started
 ===============
 
-.. code: console
+Install from PyPI.
+
+.. code:: console
 
    pip install atsphinx-feed
+
+Configure your ``conf.py``.
+
+.. code:: python
+
+   extensions = [
+       "atsphinx.feed",
+       "atsphinx.og_article",
+   ]
+
+When you build by html-like builder, this generates Atom style feed file into outdir.
+
+  _build/html/
+    index.html
+    _static/
+    atom.xml <- Generated!!
+
+You can configure behevior of extension.
+Please see docs.
diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.0
+current_version = 0.1.0
 commit = True
 tag = False
 message = release: Bump version {current_version} -> {new_version}

diff --git a/src/atsphinx/feed/__init__.py b/src/atsphinx/feed/__init__.py
@@ -4,7 +4,7 @@
 
 from . import processors
 
-__version__ = "0.0.0"
+__version__ = "0.1.0"
 
 
 def validate_config(app: Sphinx, config: Config):