Skip to content
This repository has been archived by the owner on Apr 13, 2023. It is now read-only.

Commit

Permalink
Further improvements to consistency of documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fgimian committed Jun 1, 2016
1 parent a4f56b9 commit 81125db
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 9 deletions.
16 changes: 10 additions & 6 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
Changelog
---------

*You can click a version to see a diff with the previous release.*

`Unreleased <https://github.com/fgimian/painter/compare/v0.3.1...master>`_
`Unreleased <https://github.com/fgimian/painter/tree/master>`_
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

- TBA

`0.3.1 <https://github.com/fgimian/painter/compare/v0.3...v0.3.1>`_ (2014-04-29)
`Full Source Code Changelog <https://github.com/fgimian/painter/compare/v0.3.1...master>`_

`0.3.1 <https://github.com/fgimian/painter/releases/tag/v0.3.1>`_ (2014-04-29)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

- Made strip-color CLI script more robust when errors occur

`0.3 <https://github.com/fgimian/painter/compare/v0.2...v0.3>`_ (2014-04-28)
`Full Source Code Changelog <https://github.com/fgimian/painter/compare/v0.3...v0.3.1>`_

`0.3 <https://github.com/fgimian/painter/releases/tag/v0.3>`_ (2014-04-28)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

- Implemented coloring support for Windows using the colorama
Expand All @@ -30,7 +32,9 @@ Changelog
with Painter.
- Several bug fixes.

0.2 (2014-04-26)
`Full Source Code Changelog <https://github.com/fgimian/painter/compare/v0.2...v0.3>`_

`0.2 <https://github.com/fgimian/painter/releases/tag/v0.2>`_ (2014-04-26)
++++++++++++++++

- Initial release
12 changes: 9 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Painter
.. |Coverage Status| image:: https://coveralls.io/repos/fgimian/painter/badge.svg
:target: https://coveralls.io/r/fgimian/painter
.. |License| image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://pypi.python.org/pypi/painter/
:target: https://github.com/fgimian/painter/blob/master/LICENSE
.. |Latest Version| image:: https://img.shields.io/pypi/v/painter.svg
:target: https://pypi.python.org/pypi/painter/

Expand All @@ -18,6 +18,9 @@ Painter
Awesome artwork provided courtesy of `Open Clip Art
Library <http://openclipart.org/detail/174634/painter-penguin-by-moini-174634>`_

Introduction
------------

Painter is an ANSI coloring library based on the excellent
`chalk <https://github.com/sindresorhus/chalk>`_ and
`colors.js <https://github.com/marak/colors.js/>`_ libraries for
Expand Down Expand Up @@ -84,8 +87,11 @@ The output of the script above looks something like this:
.. image:: https://raw.githubusercontent.com/fgimian/painter/master/images/painter-demo.png
:alt: Painter Demo

Please see the `usage documentation <https://github.com/fgimian/painter/blob/master/USAGE.rst>`_
for further instruction.
Documentation
-------------

Please check out the `Painter Usage documentation
<https://github.com/fgimian/painter/blob/master/USAGE.rst/>`_.

Running Tests
-------------
Expand Down

0 comments on commit 81125db

Please sign in to comment.