Skip to content

Commit

Permalink
📚 synchronize readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chfw committed Nov 10, 2019
1 parent fce39a6 commit f5a451c
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 20 deletions.
File renamed without changes.
2 changes: 1 addition & 1 deletion .moban.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ configuration:
configuration: pyexcel-xlsx.yml
targets:
- Pipfile: Pipfile.jj2
- README.rst: README.rst
- README.rst: custom_README.rst.jj2
- setup.py: setup.py
- "docs/source/conf.py": "docs/source/conf.py.jj2"
- .travis.yml: travis.yml
Expand Down
29 changes: 10 additions & 19 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,22 @@ pyexcel-xlsx - Let you focus on data, instead of xlsx format
================================================================================

.. image:: https://raw.githubusercontent.com/pyexcel/pyexcel.github.io/master/images/patreon.png
:target: https://www.patreon.com/pyexcel

.. image:: https://api.bountysource.com/badge/team?team_id=288537
:target: https://salt.bountysource.com/teams/chfw-pyexcel
:target: https://www.patreon.com/chfw

.. image:: https://travis-ci.org/pyexcel/pyexcel-xlsx.svg?branch=master
:target: http://travis-ci.org/pyexcel/pyexcel-xlsx

.. image:: https://codecov.io/gh/pyexcel/pyexcel-xlsx/branch/master/graph/badge.svg
:target: https://codecov.io/gh/pyexcel/pyexcel-xlsx

.. image:: https://badge.fury.io/py/pyexcel-xlsx.svg
:target: https://pypi.org/project/pyexcel-xlsx


.. image:: https://pepy.tech/badge/pyexcel-xlsx/month
:target: https://pepy.tech/project/pyexcel-xlsx/month


.. image:: https://img.shields.io/gitter/room/gitterHQ/gitter.svg
:target: https://gitter.im/pyexcel/Lobby

Expand Down Expand Up @@ -57,7 +62,7 @@ Support the project
================================================================================

If your company has embedded pyexcel and its components into a revenue generating
product, please support me on `patreon <https://www.patreon.com/bePatron?u=5537627>`_
product, please support me on `github <https://github.com/sponsors/chfw>`_, `patreon <https://www.patreon.com/bePatron?u=5537627>`_
or `bounty source <https://salt.bountysource.com/teams/chfw-pyexcel>`_ to maintain
the project and develop it further.

Expand Down Expand Up @@ -352,8 +357,6 @@ How to update test environment and update documentation
Additional steps are required:

#. pip install moban
#. git clone https://github.com/moremoban/setupmobans.git # generic setup
#. git clone https://github.com/pyexcel/pyexcel-commons.git commons
#. make your changes in `.moban.d` directory, then issue command `moban`

What is pyexcel-commons
Expand All @@ -366,18 +369,6 @@ What is .moban.d

`.moban.d` stores the specific meta data for the library.

Acceptance criteria
-------------------

#. Has Test cases written
#. Has all code lines tested
#. Passes all Travis CI builds
#. Has fair amount of documentation if your change is complex
#. run 'make format' so as to confirm the pyexcel organisation's coding style
#. Please update CHANGELOG.rst
#. Please add yourself to CONTRIBUTORS.rst
#. Agree on NEW BSD License for your contribution


.. testcode::
:hide:
Expand Down

0 comments on commit f5a451c

Please sign in to comment.