Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jonas-eschle committed Jan 18, 2018
1 parent 1afc63b commit 1a6a4f6
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 5 deletions.
3 changes: 2 additions & 1 deletion .landscape.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ strictness: veryhigh
# - redefined-builtin

ignore-paths:
- docs/*
- docs/
- tests/
python-targets:
- 2
- 3
Expand Down
27 changes: 23 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.. image:: https://travis-ci.org/Phynix/yamlloader.svg?branch=master
:target: https://travis-ci.org/Phynix/yamlloader

.. image:: https://landscape.io/github/Phynix/yamlloader/master/landscape.svg?style=flat
:target: https://landscape.io/github/Phynix/yamlloader/master
:alt: Code Health

.. image:: https://www.versioneye.com/user/projects/5a2f00060fb24f07e40988bf/badge.svg?style=flat-square
:target: https://www.versioneye.com/user/projects/5a2f00060fb24f07e40988bf
:alt: Dependency Status
.. image:: https://coveralls.io/repos/github/Phynix/yamlloader/badge.svg
:target: https://coveralls.io/github/Phynix/yamlloader

yamlloader
==========
Expand All @@ -24,13 +24,32 @@ when loading resp. dumping a file.
`API Documentation <https://phynix.github.io/yamlloader/index.html>`_


To install it
-------------
Install
-------
It is recommended to use the pip or anaconda version

.. code-block:: bash
$ pip install yamlloader
or

.. code-block:: bash
$ conda install yamlloader -c phynix
But does [your special case] also work?
---------------------------------------

Tests are run continuously using randomly generated yaml files.
Also, there are no fails to be expected.

Still, if you are concerned that *your* special case may breaks in the future, please
add your own tests as `test_ext_anyname.py` under `tests/` or let us know about your needs.
This guarantees that no code will be added that breaks *your* case.


Loader usage
------------

Expand Down

0 comments on commit 1a6a4f6

Please sign in to comment.