branch: externals/org-modern
commit a5ed40c3ab940d1ad085c9d97cd545952605308f
Author: JD Smith <93749+jdtsm...@users.noreply.github.com>
Commit: GitHub <nore...@github.com>
Update README.md
Update screenshots and mention org-bullets instead of org-modern-hide-stars.
---
README.md | 23 ++++++++++++++++++++++-
1 file changed, 22 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 9313ca18d1..4635764eac 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ Modern block styling with `org-indent`.
This small package reproduces the block styling of `org-modern` when using
`org-indent`:
<p align="center">
-<img
src=https://user-images.githubusercontent.com/93749/172438142-d4090856-dea8-43d0-a68a-bba29198575f.png>
+<img
src=https://user-images.githubusercontent.com/93749/172964083-afafa737-3b54-4d9e-aaf0-9a4741fa085c.png>
</p>
## Notes
@@ -26,6 +26,27 @@ Be sure to enable `org-indent` (see `org-startup-indented`).
(org-mode . org-modern-indent-mode))
```
+Optional, if you want to use org-modern too:
+
+```elisp
+(use-package org-modern
+ :ensure t
+ :custom
+ (org-modern-hide-stars nil) ; adds extra indentation
+ :hook
+ (org-mode . org-modern-mode)
+ (org-agenda-finalize . org-modern-agenda))
+```
+Also optional; use org-bullets instead for nice bullet stars.
+
+```elisp
+(use-package org-bullets-mode
+ :ensure org-bullets
+ :config
+ :hook org-mode)
+```
+
+
## Related packages
- [`org-modern`](https://github.com/minad/org-modern): A modern org styling.
Works best without org-indent.
