readme

templateless · Feb 29, 2024 · 1b2aa7e · 1b2aa7e
1 parent 6e1f556
commit 1b2aa7e
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # CHANGELOG
 
+**Unreleased:**
+- `README.md`: markdown supports ordered/unordered lists
+
 **v0.1.4:**
 - `README.md` cleanup (listing of components)
 - `Image` component now requires only `src`; the other params are optional

diff --git a/README.md b/README.md
@@ -128,6 +128,22 @@ Text component allow you to insert a paragraph. Each paragraph supports basic ma
   - `# Big Header`
   - `###### Small Header`
 
+- Unordered list:
+
+  ```md
+  - item one
+  - item two
+  - item three
+  ```
+
+- Ordered list:
+
+  ```md
+  1. item one
+  1. item two
+  1. item three
+  ```
+
 ```cs
 Content.Builder()
     .Text("## Thank you for signing up")
@@ -254,6 +270,8 @@ Content.Builder()
 
 </details>
 
+---
+
 Components can be placed in the header, body and footer of the email. Header and footer styling is usually a bit different from the body (for example the text is smaller).
 
 ```cs