Skip to content

Commit

Permalink
Update docs as the package is available on PyPI
Browse files Browse the repository at this point in the history
Nitpick: also include complete imports for the example.
  • Loading branch information
sebastianmanger committed Feb 1, 2022
1 parent 070e700 commit 63bd171
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 = (
...,
Expand All @@ -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
Expand Down

0 comments on commit 63bd171

Please sign in to comment.