From 8560a30bc503c03273a7e89cecbff3e7e1cde825 Mon Sep 17 00:00:00 2001
From: John Vandenberg <jayvdb@gmail.com>
Date: Thu, 7 Jun 2018 09:28:12 +0700
Subject: [PATCH] :microscope: implement README.rst using templates

Also mention @coala uses this project.
---
 .moban.dt/local-README.rst.jj2 | 49 ++++++++++++++++++++++++++++++++++
 README.rst                     | 21 +++++++++++----
 config/data.yml                |  5 +++-
 local.yml                      |  2 ++
 4 files changed, 71 insertions(+), 6 deletions(-)
 create mode 100644 .moban.dt/local-README.rst.jj2

diff --git a/.moban.dt/local-README.rst.jj2 b/.moban.dt/local-README.rst.jj2
new file mode 100644
index 0000000..5f9f034
--- /dev/null
+++ b/.moban.dt/local-README.rst.jj2
@@ -0,0 +1,49 @@
+{% extends 'README.rst.jj2' %}
+
+{% block documentation_link %}
+{% endblock %}
+
+{% block features %}
+{{description}}
+It is used with `yehua <https://github.com/chfw/yehua>`_.
+Organisations using it:
+
+- `pyexcel <https://github.com/pyexcel/pyexcel>`_.
+- `coala <https://github.com/coala/coala>`_.
+
+Features
+================================================================================
+
+setup.py
+----------
+
+1. flake8 compliant setup.py
+
+2. feature parity with `kennethreitz/setup.py <https://github.com/kennethreitz/setup.py>`_
+
+   - automatically upload to pypi without using twine
+
+   - automatically do git release while uploading to pypi
+
+3. configured to build universial wheels by default
+{% endblock %}
+
+{% block bottom_block %}
+Notes
+================================================================================
+
+
+In order to run, `python setup.py publish`, you will have setup `.pypirc` in
+your home folder as::
+
+   [distutils]
+   index-servers =
+     pypi
+
+   [pypi]
+   username=your_name
+   password=your_password
+
+
+And you need to configure `gease`.
+{% endblock %}
diff --git a/README.rst b/README.rst
index c35ae01..42439c5 100644
--- a/README.rst
+++ b/README.rst
@@ -5,8 +5,19 @@ pypi-mobans
 .. image:: https://api.travis-ci.org/moremoban/pypi-mobans.svg?branch=master
    :target: http://travis-ci.org/moremoban/pypi-mobans
 
-Scaffolding templates for your Python project. It is used with `yehua <https://github.com/chfw/yehua>`_
-and `pyexcel <https://github.com/pyexcel/pyexcel>`_.
+.. image:: https://codecov.io/github/moremoban/pypi-mobans/coverage.png
+   :target: https://codecov.io/github/moremoban/pypi-mobans
+
+.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
+   :target: https://gitter.im/chfw_moban/Lobby
+
+
+Scaffolding templates for your Python project.
+It is used with `yehua <https://github.com/chfw/yehua>`_.
+Organisations using it:
+
+- `pyexcel <https://github.com/pyexcel/pyexcel>`_.
+- `coala <https://github.com/coala/coala>`_.
 
 Features
 ================================================================================
@@ -31,8 +42,8 @@ You can get it:
 
 .. code-block:: bash
 
-    $ git clone http://github.com/moremoban/pypi-mobans.git
-
+    $ git clone https://github.com/moremoban/pypi-mobans.git
+    $ cd pypi-mobans
 
 Notes
 ================================================================================
@@ -50,4 +61,4 @@ your home folder as::
    password=your_password
 
 
-And you need to configure `gease`. 
+And you need to configure `gease`.
diff --git a/config/data.yml b/config/data.yml
index 0120d81..e0ea3b7 100644
--- a/config/data.yml
+++ b/config/data.yml
@@ -8,4 +8,7 @@ contact: wangc_2011@hotmail.com
 license: NEW BSD
 company: Onni Software Ltd.
 branch: master
-description: this is a base for python project scaffolding
+description: Scaffolding templates for your Python project.
+release: 0.0.0
+gitter_room: chfw_moban/Lobby
+setup_py: false
diff --git a/local.yml b/local.yml
index 0e28e0d..70d0431 100644
--- a/local.yml
+++ b/local.yml
@@ -1,7 +1,9 @@
 configuration:
   configuration: config/data.yml
   template_dir:
+    - .moban.dt/
     - templates
 targets:
   - .gitignore: gitignore.jj2
   - LICENSE: NEW_BSD_LICENSE.jj2
+  - README.rst: local-README.rst.jj2