libertytechforce
/
pyinfra-docker-compose
2
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Compare commits

base: libertytechforce:4ceb7975811e011af277e584d6c34541c792759d
Branches Tags
libertytechforce:master
...
compare: libertytechforce:55a56d18593701facfd7bdac84808d71f2a87a89
Branches Tags
libertytechforce:master

2 Commits
4ceb797581 ... 55a56d1859

Author SHA1 Message Date
Raoul Snyman 55a56d1859 Merge pull request 'Fix README' (#2) from raoul/pyinfra-docker-compose:fix-readme into master 
Reviewed-on: #2
 2022-11-24 07:20:39 +00:00
Raoul Snyman 33d6da9306 Fix README 2022-11-24 00:19:38 -07:00
1 changed files with 17 additions and 5 deletions
Show Stats Expand all files Collapse all files

22
README.rst
View File

@ -4,12 +4,14 @@ pyinfra-docker-compose
.. image:: https://img.shields.io/pypi/v/pyinfra .. image:: https://img.shields.io/pypi/v/pyinfra
:alt: PyPI - Version :alt: PyPI - Version
-----
A pyinfra module to install the Docker Compose plugin. A pyinfra module to install the Docker Compose plugin.
.. contents:: Table of Contents Table of Contents
:depth: 1 -----------------
- `Installation <#installation>`_
- `Usage <#usage>`_
- `License <#license>`_
Installation Installation
------------ ------------
@ -18,10 +20,20 @@ Installation
pip install pyinfra-docker-compose pip install pyinfra-docker-compose
Usage
-----
.. code-block:: python
from pyinfra_docker_compose import deploy_docker_compose
deploy_docker_compose()
License License
------- -------
``pyinfra-docker-compose`` is distributed under the terms of the `MIT`_ license. ``pyinfra-docker-compose`` is distributed under the terms of the `MIT`_ license.
.. MIT:: https://spdx.org/licenses/MIT.html .. _MIT: https://spdx.org/licenses/MIT.html