branch: elpa/spacemacs-theme
commit 13940be5e797d04b290f9db940e46632cd1a4dc8
Author: nashamri <[email protected]>
Commit: nashamri <[email protected]>
Update README
---
README.md | 47 +++++++++++++++++++++++++++++++++++------------
1 file changed, 35 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index 6182c431da..520ad901cc 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,43 @@
# Spacemacs-theme
-
+
-# How to install it in spacemacs
+Spacemacs theme is an Emacs color theme that started as a theme for
[spacemacs](https://github.com/syl20bnr/spacemacs).
-* Clone the repo into `~/.emacs.d/private/`
+# Screenshots
-```
-cd ~/.emacs.d/private
-git clone https://github.com/nashamri/spacemacs-theme
-```
+
-* Add this into your `.spacemacs` (in your `dotspacemacs/config`)
+# Highlights
-```
-(add-to-list 'custom-theme-load-path "~/.emacs.d/private/spacemacs-theme")
-```
+The theme has good support for org mode.
-* Select the light or dark version by `SPC T h`
+
+
+# Supported modes
+
+Some of the supported modes are:
+
+* company
+* ein
+* erc
+* gnus
+* helm
+* ido
+* info
+* magit
+* neotree
+* org
+* and others :) more are coming!
+
+# Customizations
+
+The theme has some options that can be tweaked via `M-x customize`:
+
+### `spacemacs-theme-comment-bg`:
+
+This toggles a background color for the comment lines.
+
+### `spacemacs-theme-org-height`:
+
+This toggles the use of varying headings heights.