Add basic Readme instructions

jhthompson · Apr 10, 2024 · 60ff6fc · 60ff6fc
1 parent 6db0e0f
commit 60ff6fc
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,42 @@
+# django-bootstrap-email
+
+## Usage
+
+1. Install
+
+```shell
+pip install django-bs-email
+```
+
+2. Add to `INSTALLED_APPS`
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "django_bootstrap_email",
+]
+```
+
+3. Use the template tag
+
+```html
+{% load bootstrap_email %}
+
+{% bootstrap_email %}
+<body class="bg-light">
+  <div class="container">
+    <div class="card my-10">
+      <div class="card-body">
+          <p>
+            Hello World!
+          </p>
+      </div>
+    </div>
+  </div>
+</body>
+{% end_bootstrap_email %}
+```
+
+And a complete HTML email will be output, which should render correctly across email clients:
+
+![Rendered HTML email example](example.png)
diff --git a/example.png b/example.png