Skip to content

Commit c398050

Browse files
committed
Update documentation
1 parent 2ef7632 commit c398050

File tree

1 file changed

+24
-11
lines changed

1 file changed

+24
-11
lines changed

docs/index.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,46 @@ Model Bakery offers you a smart way to create fixtures for testing in Django.
44

55
With a simple and powerful API, you can create many objects with a single line of code.
66

7-
Model Bakery is a rename of the legacy [model_mommy\'s project](https://pypi.org/project/model_mommy/). This is because the project\'s creator and maintainers decided to not reinforce gender stereotypes for women in technology. You can read more about this subject[here](https://witi.com/articles/1017/How-Gender-Stereotypes-are-Still-Affecting-Women-in-Tech/).
7+
Model Bakery is a rename of the legacy [model_mommy's project](https://pypi.org/project/model_mommy/). This change was made to avoid reinforcing gender stereotypes in technology.
8+
You can read more about this subject [here](https://witi.com/articles/1017/How-Gender-Stereotypes-are-Still-Affecting-Women-in-Tech/).
89

9-
# Compatibility
10+
Documentation: [https://model-bakery.readthedocs.io](https://model-bakery.readthedocs.io)
11+
Source code: [https://github.com/model-bakers/model_bakery/](https://github.com/model-bakers/model_bakery/)
1012

11-
Model Bakery supports Django \>= 4.2.
13+
## Key Features
1214

13-
# Install
15+
Model-bakery is an open-source Python library for Django that:
1416

15-
Install it with `pip`
17+
- Automatically generates test data for Django models
18+
- Provides sensible defaults for all field types
19+
- Supports custom field overrides and "recipes" for reusable patterns
20+
- Handles related models and complex relationships
21+
- Works with currently maintained versions of Python and Django
22+
23+
## Installation
1624

1725
```console
1826
$ pip install model-bakery
1927
```
2028

21-
# Contributing to Model Bakery
29+
## Contributing to Model Bakery
2230

23-
As an open-source project, Model Bakery welcomes contributions of many forms. Examples of contributions include:
31+
As an open-source project, Model Bakery welcomes contributions of many forms:
2432

25-
- Code Patches
33+
- Code patches
2634
- Documentation improvements
2735
- Bug reports
2836

29-
Take a look in our [GitHub repo](https://github.com/model-bakers/model_bakery/blob/main/CONTRIBUTING.md) for more instructions on how to set up your local environment to help Model Bakery to grow.
37+
Take a look at our [GitHub repo](https://github.com/model-bakers/model_bakery/blob/main/CONTRIBUTING.md) for instructions on how to set up your local environment to help Model Bakery to grow.
38+
39+
## Support
40+
41+
Feel free to [open an issue](https://github.com/model-bakers/model_bakery/issues/new) for support, development ideas, or questions!
3042

31-
# Doubts? Loved it? Hated it? Suggestions?
43+
## License
3244

33-
Feel free to [open an issue](https://github.com/model-bakers/model_bakery/issues/new) for support, development or ideas!
45+
Model Bakery is licensed under the MIT License.
46+
See the [LICENSE](https://github.com/model-bakers/model_bakery/blob/main/LICENSE) file for more information.
3447

3548
## Contents
3649

0 commit comments

Comments
 (0)