add doc

Author: bfontaine

Diff for: CHANGELOG.md

@@ -1,7 +1,9 @@
 # Bixomix Changelog
 
-## Unreleased
+## 0.1.1 (unreleased)
 
+* Add `EnabledMixin`, `EnabledNoMixin`
+* Add `UpdateFromDictMixin`
 * Document `UpdatedAtMixin`’s compatibility with Postgres (#1)
 
 ## 0.1.0 (2023/03/30)

Diff for: LICENSE

@@ -1,4 +1,4 @@
-Copyright © 2022-2023 – Bixoto.com
+Copyright © 2022-2024 – Bixoto.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

Diff for: README.md

@@ -18,14 +18,14 @@ Add mixins after the `Base` class in each model’s parent classes. The order of
 ```python
 from sqlalchemy.orm import DeclarativeBase
 
-from bixomix import CreatedAtMixin
+from bixomix import CreatedAtMixin, EnabledMixin
 
 
 class Base(DeclarativeBase):
     pass
 
 
-class MyModel(Base, CreatedAtMixin):
+class MyModel(Base, CreatedAtMixin, EnabledMixin):
     # Add your own fields here
     ...
 ```
@@ -36,3 +36,6 @@ class MyModel(Base, CreatedAtMixin):
 * `UpdatedAtMixin`: add an `updated_at` datetime field that’s automatically filled with the record’s last update date.
   Note that on Postgres this is done in Python; for a database-level update you have to [create a trigger](https://stackoverflow.com/a/71072370/735926).
 * `CreatedUpdatedAtMixin`: combined version of the previous two mixins
+* `EnabledMixin`: add an `enabled` boolean field (default is `true`)
+* `EnabledNoMixin`: same as `EnabledMixin`, but the default value is `false`
+* `UpdateFromDictMixin`: add an `update_from_dict` method to update a model in-place given a dictionary of attributes