Skip to content

Commit

Permalink
Provided better documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
retr0h committed Nov 28, 2016
1 parent f99ebe0 commit fa62d1c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 10 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Install gilt using pip:
$ pip install gilt-python
Overlay a remote repository into the destination provided.
Overlay remote repositories and/or files into the destinations provided.

.. code-block:: bash
$ gilt overlay
$ gilt --debug overlay
Documentation
=============
Expand Down
24 changes: 16 additions & 8 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Overlay a remote repository into the destination provided.
$ gilt overlay
Overlay files from a remote repository into the destination(s) provided.
Overlay files from a remote repository into the destinations provided.

.. code-block:: yaml
:caption: gilt.yml
Expand All @@ -36,7 +36,7 @@ Overlay files from a remote repository into the destination(s) provided.
$ gilt overlay
Overlay directories from a remote repository into the destination(s) provided.
Overlay a directory from a remote repository into the destination provided.

.. code-block:: yaml
:caption: gilt.yml
Expand All @@ -63,18 +63,26 @@ Use an alternate config file (default `gilt.yml`).
$ gilt --config /path/to/gilt.yml overlay
Integration
===========
Molecule
========

Integration with `Molecule`_ underway, as an `Ansible Galaxy`_ CLI replacement.
Integrates with `Molecule`_ as an `Ansible Galaxy`_ CLI replacement. Update
`molecule.yml` with the following.

.. code-block:: yaml
---
dependency:
name: shell
command: gilt overlay
Testing
=======

::
.. code-block:: bash
$ pip install tox
$ tox
$ pip install tox
$ tox
Similar Tools
=============
Expand Down

0 comments on commit fa62d1c

Please sign in to comment.