Skip to content

Commit e49376a

Browse files
committed
📚 extend the basic readme
1 parent 71e659c commit e49376a

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

templates/README.rst.jj2

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
================================================================================
2-
{{name}}
2+
{{name}}{% if full_name %} - {{full_name}}
3+
{%endif%}
34
================================================================================
45

56
.. image:: https://api.travis-ci.org/{{organisation}}/{{name}}.svg?branch=master
67
:target: http://travis-ci.org/{{organisation}}/{{name}}
78

8-
.. image:: https://codecov.io/github/{{organisation}}/{{name}}/coverage.png
9-
:target: https://codecov.io/github/{{organisation}}/{{name}}
9+
.. image:: https://codecov.io/gh/{{organisation}}/{{name}}/branch/master/graph/badge.svg
10+
:target: https://codecov.io/gh/{{organisation}}/{{name}}
1011

1112
{%block documentation_link%}
1213
.. image:: https://readthedocs.org/projects/{{name|lower}}/badge/?version=latest
1314
:target: http://{{name|lower}}.readthedocs.org/en/latest/
1415
{%endblock%}
1516

17+
{% block features %}
18+
{% endblock %}
1619

1720
Installation
1821
================================================================================
1922

23+
{% if release != '0.0.0' %}
24+
2025
You can install it via pip:
2126

2227
.. code-block:: bash
@@ -25,9 +30,13 @@ You can install it via pip:
2530

2631

2732
or clone it and install it:
33+
{% endif %}
2834

2935
.. code-block:: bash
3036

3137
$ git clone http://github.com/{{organisation}}/{{name}}.git
3238
$ cd {{name}}
3339
$ python setup.py install
40+
41+
{%block bottom_block%}
42+
{%endblock%}

0 commit comments

Comments
 (0)