Skip to content

Commit a6fdc61

Browse files
authored
Update documentation (#521)
1 parent 2ef7632 commit a6fdc61

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

docs/index.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,45 @@ 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)
1011

11-
Model Bakery supports Django \>= 4.2.
12+
Source code: [https://github.com/model-bakers/model_bakery/](https://github.com/model-bakers/model_bakery/)
1213

13-
# Install
14+
## Key Features
1415

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

1724
```console
1825
$ pip install model-bakery
1926
```
2027

21-
# Contributing to Model Bakery
28+
## Contributing to Model Bakery
2229

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

25-
- Code Patches
32+
- Code patches
2633
- Documentation improvements
2734
- Bug reports
2835

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.
36+
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.
37+
38+
## Support
39+
40+
Feel free to [open an issue](https://github.com/model-bakers/model_bakery/issues/new) for support, development ideas, or questions!
3041

31-
# Doubts? Loved it? Hated it? Suggestions?
42+
## License
3243

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

3547
## Contents
3648

0 commit comments

Comments
 (0)