Merge pull request 'Fix README' (#2) from raoul/pyinfra-docker-compose:fix-readme into master

Reviewed-on: #2
master
Raoul Snyman 2022-11-24 07:20:39 +00:00
commit 55a56d1859
1 changed files with 17 additions and 5 deletions

View File

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