branch: externals/nano-modeline
commit 8347f1300ec237be65b4feab5fd5ef98b46191ec
Author: Nicolas P. Rougier <[email protected]>
Commit: Nicolas P. Rougier <[email protected]>
Updated README
---
README.md | 37 ++++++++++++++++++++++++++-----------
nano-modeline.el | 13 ++++++++-----
2 files changed, 34 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index f329514..0346170 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,31 @@
## N Λ N O Modeline
-A simple modeline. Best with [N Λ N O
theme](https://github.com/rougier/nano-theme).
+Nano modeline is a minor mode that modify the modeline as:
+
+[ status | name (primary) secondary ]
+
+It can be displayed at the bottom (mode-line) or at the top (header-line)
+depending on nano-modeline-position custom setting.
+
+There are two sets of faces (for active and inactive modelines) that
+can be customized (M-x: customize-group + nano-modeline)
+
+- nano-modeline-active-name / nano-modeline-inactive-name
+- nano-modeline-active-primary / nano-modeline-inactive-primary
+- nano-modeline-active-secondary / nano-modeline-inactive-secondary
+- nano-modeline-active-status-RO / nano-modeline-inactive-status-RO
+- nano-modeline-active-status-RW / nano-modeline-inactive-status-RW
+- nano-modeline-active-status-** / nano-modeline-inactive-status-**
+
+### Installation
+
+Install with `M-: (package-install 'nano-modeline)`
+
+### Usage example:
+
+Activate with ` M-x: nano-modeline-mode`
+
+### Screenshots (using [N Λ N O theme](https://github.com/rougier/nano-theme)):
@@ -19,13 +44,3 @@ A simple modeline. Best with [N Λ N O
theme](https://github.com/rougier/nano-th
-### Installation
-
-Install with `M-: (package-install 'nano-modeline)`
-
-
-### Usage
-
-```
-(nano-modeline)
-```
diff --git a/nano-modeline.el b/nano-modeline.el
index 2c779cf..2f33915 100644
--- a/nano-modeline.el
+++ b/nano-modeline.el
@@ -4,7 +4,7 @@
;; Maintainer: Nicolas P. Rougier <[email protected]>
;; URL: https://github.com/rougier/nano-modeline
-;; Version: 0.1
+;; Version: 0.2
;; Package-Requires: ((emacs "27.1"))
;; Keywords: convenience, mode-line, header-line
@@ -25,10 +25,10 @@
;;; Commentary:
;;
-;; Nano modeline is a custome modeline rendered as:
+;; Nano modeline is a minor mode that modify the modeline as:
;; [ status | name (primary) secondary ]
;;
-;; It can be displayed on bottom (mode-line) or top (header-line)
+;; It can be displayed at the bottom (mode-line) or at the top (header-line)
;; depending on nano-modeline-position custom setting.
;;
;; There are two sets of faces (for active and inactive modelines) that
@@ -43,13 +43,17 @@
;;
;; Usage example:
;;
-;; M-x: nano-modeline
+;; M-x: nano-modeline-mode
;;
;;; NEWS:
;;
+;; Vesrion 0.2
+;; - Implements modeline as minor mode
+;;
;; Version 0.1
;; - Submission to ELPA
;;
+
;;; Code:
(defgroup nano nil
"N Λ N O"
@@ -261,7 +265,6 @@ Modeline is composed as:
(concat "(" (elfeed-search--header) ")")
""))
-;; Elfeed (regular header)
(defun nano-modeline-elfeed-setup-header ()
(setq header-line-format (default-value 'header-line-format)))
