From 33d6da9306810384b3d45cd60770c66e2806fa18 Mon Sep 17 00:00:00 2001 From: Raoul Snyman Date: Thu, 24 Nov 2022 00:05:00 -0700 Subject: [PATCH] Fix README --- README.rst | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index d289e10..df483ed 100644 --- a/README.rst +++ b/README.rst @@ -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