From 63bd1717e6d0dc3c06bcf0544d99043548a089f7 Mon Sep 17 00:00:00 2001 From: Sebastian Manger Date: Tue, 1 Feb 2022 10:58:17 +0100 Subject: [PATCH] Update docs as the package is available on PyPI Nitpick: also include complete imports for the example. --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7812077..f88f84c 100644 --- a/README.md +++ b/README.md @@ -45,12 +45,11 @@ This project is in a early stage. All feedback is welcome! Please mail me at fsb # Installation -This project will be available on pypi after the first release. In the meantime, please install the master branch from -git using +Install the package from PyPI: - pip install https://github.com/fsbraun/django-automations/archive/master.zip + pip install django-automations -After installation add the `automations` to your installed apps in `settings.py`: +Add `automations` to your installed apps in `settings.py`: INSTALLED_APPS = ( ..., @@ -74,7 +73,9 @@ in one place all business processes which in a Django app often are distributed carried out. from automations import flow - from automations.flow import this + from automations.flow import Automation + from automations.flow import this + # "this" can be used in a class definition as a replacement for "self" from . import forms