From a5c4d31c707d4bcf07dff285fc64cf287a70e15e Mon Sep 17 00:00:00 2001 From: Pascal F Date: Wed, 1 May 2024 09:09:39 +0200 Subject: [PATCH] Update presentation --- README.md | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index e964758..61e2c6a 100644 --- a/README.md +++ b/README.md @@ -8,26 +8,24 @@ django-fsm adds simple declarative state management for django models. -Nice introduction is available here: - -> Django FSM-2 is a fork of Django FSM. Big thanks to Mikhail Podgurskiy for starting and this project and maintaining it for so many years. Unfortunately, development has stalled for almost 2 years and it was officially announced there will be no new releases. Django FSM-2 is the new updated version of Django FSM, with dependencies updates, typing (planed). Original repository: - -## Alternatives +> [!IMPORTANT] +> Django FSM-2 started as a fork of [Django FSM](https://github.com/viewflow/django-fsm). +> +> Big thanks to Mikhail Podgurskiy for starting this awesome project and maintaining it for so many years. +> +> Unfortunately, development has stalled for almost 2 years and it was officially announced there will be no new releases. [Viewflow](https://github.com/viewflow/viewflow) is presented as an alternative but the transition is not that easy. +> +> If what you need is just a simple state machine, tailor-made for Django, Django FSM-2 is the successor of Django FSM, with dependencies updates, typing (planned) -If you need parallel task execution, views and background task code reuse -over different flows - check my new project django-viewflow: +## Introduction -## Objective +**FSM really helps to structure the code, and centralize the lifecycle of your Models.** -Instead of adding a state field to a django model and managing its -values by hand, you use `FSMField` and mark model methods with the -`transition` decorator. These methods could contain side-effects of the -state change. +Instead of adding a CharField field to a django model and manage its +values by hand everywhere, `FSMFields` offer the ability to declare your +`transitions` once with the decorator. These methods could contain side-effects, permissions, or logic to make the lifecycle management easier. - -FSM really helps to structure the code, especially when a new developer -comes to the project. FSM is most effective when you use it for some -sequential steps. +Nice introduction is available here: ## Installation