Skip to content

Commit 60ff6fc

Browse files
committed
Add basic Readme instructions
1 parent 6db0e0f commit 60ff6fc

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

README.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# django-bootstrap-email
2+
3+
## Usage
4+
5+
1. Install
6+
7+
```shell
8+
pip install django-bs-email
9+
```
10+
11+
2. Add to `INSTALLED_APPS`
12+
13+
```python
14+
INSTALLED_APPS = [
15+
# ...
16+
"django_bootstrap_email",
17+
]
18+
```
19+
20+
3. Use the template tag
21+
22+
```html
23+
{% load bootstrap_email %}
24+
25+
{% bootstrap_email %}
26+
<body class="bg-light">
27+
<div class="container">
28+
<div class="card my-10">
29+
<div class="card-body">
30+
<p>
31+
Hello World!
32+
</p>
33+
</div>
34+
</div>
35+
</div>
36+
</body>
37+
{% end_bootstrap_email %}
38+
```
39+
40+
And a complete HTML email will be output, which should render correctly across email clients:
41+
42+
![Rendered HTML email example](example.png)

example.png

1.62 KB
Loading

0 commit comments

Comments
 (0)