Skip to content

Commit 5242ac9

Browse files
committed
Readme update.
1 parent 6a4b8b0 commit 5242ac9

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@ codeorigins
22
===========
33
https://github.com/idlesign/codeorigins
44

5-
|python|
5+
|python| |release|
66

77
.. |python| image:: http://forthebadge.com/images/badges/made-with-python.svg
88
:target: https://www.python.org
99

10+
.. |release| image:: https://img.shields.io/pypi/v/codeorigins.svg
11+
:target: https://pypi.python.org/pypi/codeorigins
1012

1113

1214
Description
@@ -38,10 +40,10 @@ FAQ
3840

3941
1. Fork repository;
4042
2. Git pull forked repository into local directory;
41-
3. ``cd`` to the directory;
42-
4. ``pip install -e .`` (``sudo`` may be required) -
43+
3. ``$ cd`` to the directory;
44+
4. ``$ pip install -e .`` (``sudo`` may be required) -
4345
this will made ``codeorigins`` CLI available;
44-
5. Use ``codeorigins dump`` (see below) without ``--into`` -
46+
5. Use ``$ codeorigins dump`` (see below) without ``--into`` -
4547
this puts dumps into ``codeorigins/dump/``;
4648
6. Commit and push added/changed dumps;
4749
7. Create a pull request on your GitHub repository page.
@@ -66,7 +68,7 @@ Using rate-limited GitHub search API:
6668

6769
.. code-block:: bash
6870
69-
> codeorigins dump --into /home/idle/ghdump --country ru --language Python api
71+
$ codeorigins dump --into /home/idle/ghdump --country ru --language Python api
7072
7173
This will use ``api`` to fetch repositories data for users located in ``Russia`` whose primary language is ``Python``
7274
and dump it into ``/home/idle/ghdump``.
@@ -82,7 +84,7 @@ Use ``make_html`` command to read data from dumps and compose HTML:
8284

8385
.. code-block:: bash
8486
85-
> codeorigins make_html --dump_dir /home/idle/ghdump
87+
$ codeorigins make_html --dump_dir /home/idle/ghdump
8688
8789
This will create HTML file in current working directory.
8890

@@ -94,13 +96,13 @@ See supported countries and languages using the following command:
9496

9597
.. code-block:: bash
9698
97-
> codeorigins show_settings
99+
$ codeorigins show_settings
98100
99101
100102
Requirements
101103
------------
102104

103-
* Python 3
105+
* Python 3.6+
104106
* click
105107
* Jinja2
106108
* requests

0 commit comments

Comments
 (0)