Skip to content

Commit c1318d6

Browse files
authored
Update readme (#22)
* Update presentation * pre commit update * update dependencies
1 parent b5ff9e9 commit c1318d6

File tree

5 files changed

+164
-187
lines changed

5 files changed

+164
-187
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ repos:
3737
- id: poetry-check
3838
additional_dependencies:
3939
- poetry-plugin-sort==0.2.0
40+
- poetry-plugin-export==1.8.0
4041
# FIXME: poetry lock export more platform on the CI
4142
# - id: poetry-lock
4243
# args: ["--no-update"]

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,24 @@
88

99
django-fsm adds simple declarative state management for django models.
1010

11-
Nice introduction is available here: <https://gist.github.com/Nagyman/9502133>
12-
13-
> 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: <https://github.com/viewflow/django-fsm>
14-
15-
## Alternatives
11+
> [!IMPORTANT]
12+
> Django FSM-2 started as a fork of [Django FSM](https://github.com/viewflow/django-fsm).
13+
>
14+
> Big thanks to Mikhail Podgurskiy for starting this awesome project and maintaining it for so many years.
15+
>
16+
> 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.
17+
>
18+
> 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)
1619
17-
If you need parallel task execution, views and background task code reuse
18-
over different flows - check my new project django-viewflow: <https://github.com/viewflow/viewflow>
20+
## Introduction
1921

20-
## Objective
22+
**FSM really helps to structure the code, and centralize the lifecycle of your Models.**
2123

22-
Instead of adding a state field to a django model and managing its
23-
values by hand, you use `FSMField` and mark model methods with the
24-
`transition` decorator. These methods could contain side-effects of the
25-
state change.
24+
Instead of adding a CharField field to a django model and manage its
25+
values by hand everywhere, `FSMFields` offer the ability to declare your
26+
`transitions` once with the decorator. These methods could contain side-effects, permissions, or logic to make the lifecycle management easier.
2627

27-
28-
FSM really helps to structure the code, especially when a new developer
29-
comes to the project. FSM is most effective when you use it for some
30-
sequential steps.
28+
Nice introduction is available here: <https://gist.github.com/Nagyman/9502133>
3129

3230
## Installation
3331

0 commit comments

Comments
 (0)