Skip to content

Commit

Permalink
docs: README
Browse files Browse the repository at this point in the history
  • Loading branch information
safl committed Apr 2, 2019
1 parent 3162f98 commit 39b2871
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
ymlf - Command-line YAML parser / filter
========================================

.. image:: https://travis-ci.com/safl/ymlf.svg?branch=master
:target: https://travis-ci.com/safl/ymlf

Command-line tool that parses **YAML** from `stdin` and writes the parsed
**YAML**, or a subset thereof, to `stdout`.

Please take a look at the documentation for how to install and use ``ymlf``:

* `Installation`_
* `Usage`_

If you find bugs or need help then feel free to submit an `Issue`_. If you want
to get involved head over to the `GitHub page`_ to get the source code and
submit a pull-request with your changes.

.. _Python Package Index: https://pypi.org
.. _Installation: https://kmdo.readthedocs.io/
.. _Usage: https://kmdo.readthedocs.io/
.. _GitHub page: https://github.com/safl/ymlf
.. _Issue: https://github.com/safl/ymlf/issues

0 comments on commit 39b2871

Please sign in to comment.