Bump version to 1.0b1

sphinx-notes · Feb 28, 2021 · 7c981e2 · 7c981e2
1 parent a878c19
commit 7c981e2
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 12 deletions.
diff --git a/README.rst b/README.rst
@@ -2,4 +2,8 @@
 sphinxnotes-snippet
 ===================
 
+------------------------------------------------------
+Non-intrusive snippet manager for Sphinx documentation
+------------------------------------------------------
+
 Please refer to https://sphinx-notes.github.io/snippet/ for documentation.
diff --git a/doc/index.rst b/doc/index.rst
@@ -2,9 +2,9 @@
 sphinxnotes-snippet
 ===================
 
------------------------------------------------------------------
-Non-intrusive literate programming tools for Sphinx documentation
------------------------------------------------------------------
+------------------------------------------------------
+Non-intrusive snippet manager for Sphinx documentation
+------------------------------------------------------
 
 .. image:: https://img.shields.io/github/stars/sphinx-notes/snippet.svg?style=social&label=Star&maxAge=2592000
    :target: https://github.com/sphinx-notes/snippet
@@ -38,33 +38,41 @@ TODO
               # …
               ]
 
+
 .. _Configuration:
 
+Extension
+=========
+
 Configuration
-=============
+-------------
 
 The extension provides the following configuration:
 
 :snippet_config: (Type: ``Dict[str,Any]``, Default: ``{}``)
                  Configuration of snippet cli command.
 
-:snippet_patterns: (Type: ``Dict[str,str]``, Default: ``{}``)
+:snippet_patterns: (Type: ``Dict[str,List[str]]``, Default: ``{}``)
 
-Functionalities
-===============
 
-TODO
+Command Line Tool
+=================
+
+A python script named :file:`snippet` should be installed in your path.
+(Usually :file:`/usr/local/bin` or :file:`~/.local/bin`).
+
+Invoke ``snippet --help`` for usage.
 
 Change Log
 ==========
 
-2021-02-27 1.0b0
+2021-02-28 1.0b1
 ----------------
 
 .. sectionauthor:: Shengyu Zhang
 
 - Refactor!!!
-
+- Rename from sphinxnotes-khufu
 
 2021-02-01 1.0a1
 ----------------

diff --git a/sphinxnotes/snippet/__init__.py b/sphinxnotes/snippet/__init__.py
@@ -17,10 +17,10 @@
 
 __title__= 'sphinxnotes-snippet'
 __license__ = 'BSD',
-__version__ = '1.0b0'
+__version__ = '1.0b1'
 __author__ = 'Shengyu Zhang'
 __url__ = 'https://sphinx-notes.github.io/snippet'
-__description__ = 'Non-intrusive literate programming tools for Sphinx documentation'
+__description__ = 'Non-intrusive snippet manager for Sphinx documentation'
 __keywords__ = 'documentation, sphinx, extension, utility'