Skip to content

Commit 341a107

Browse files
committed
docs(readme): update readme
1 parent 9ab7860 commit 341a107

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
DjangoEssentials.egg-info/
22
dist/
33
build/
4-
setup.py
4+
setup.py
5+
token.txt
6+

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# DjangoEssentials
22

3+
[Join Our Community - Kampus](https://discord.gg/kampus)
4+
35
DjangoEssentials is a Python library designed to streamline and enhance the development process of Django applications. It offers a collection of commonly used Django models and deployment settings, encapsulating repetitive patterns and configurations into a reusable package. The library is intended to evolve with contributions from the community, making it a collaborative project.
46

57
## Features
@@ -40,6 +42,7 @@ class YourModel(TimeBasedStampModel):
4042

4143
Configure your Django project to use MyS3Storage for handling media files with Amazon S3.
4244
Example:
45+
4346
```python
4447
# settings.py
4548
USE_S3 = True
@@ -65,6 +68,7 @@ STATICFILES_DIRS = [
6568
os.path.join(BASE_DIR, 'static/'),
6669
]
6770
```
71+
6872
Than
6973

7074
```python
@@ -77,7 +81,8 @@ class MyModel(models.Model):
7781
```
7882

7983
- **CustomUser Model**
80-
Usages:
84+
Usages:
85+
8186
```python
8287
#settings.py
8388
AUTH_USER_MODEL = 'yourapp.CustomUser'
@@ -101,13 +106,16 @@ class YourModelForm(forms.ModelForm):
101106
DjangoEssentials aims to provide more utilities and helpers over time, driven by community contributions and the evolving needs of Django developers.
102107

103108
### Contributing
109+
104110
We welcome contributions from the community, whether it's adding new features, improving documentation, or reporting bugs. Please follow these steps to contribute:
105111

106112
Fork the repository.
113+
107114
- Create your feature branch (git checkout -b feature/AmazingFeature).
108115
- Commit your changes (git commit -am 'Add some AmazingFeature').
109116
- Push to the branch (git push origin feature/AmazingFeature).
110117
- Open a Pull Request.
111118

112119
### Contact
113-
For questions or additional information, please reach out to [email protected]
120+
121+
For questions or additional information, please reach out to <[email protected]>

0 commit comments

Comments
 (0)