From ee3802a9cff763d8e9c04a010d212c416b1399e4 Mon Sep 17 00:00:00 2001 From: Davanum Srinivas Date: Thu, 24 Sep 2015 13:27:01 -0400 Subject: [PATCH] Enhance the README Change-Id: Iaa87860425aebde754e4b962b9df7f0b398415d4 --- README.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index ebf8f90..a7f38b8 100644 --- a/README.rst +++ b/README.rst @@ -10,7 +10,12 @@ Automaton :target: https://pypi.python.org/pypi/automaton/ :alt: Downloads -Friendly state machines for python. +Friendly state machines for python. The goal of this library is to provide +well documented state machine classes and associated utilities. The state +machine pattern (or the implemented variation there-of) is a commonly +used pattern and has a multitude of various usages. Some of the usages +for this library include providing state & transition validation and +running/scheduling/analyzing the execution of tasks. * Free software: Apache license * Documentation: http://docs.openstack.org/developer/automaton