Fix #51: add FAQ in README.

README.md

@@ -5,12 +5,16 @@
 [![MELPA Stable](https://stable.melpa.org/packages/doom-modeline-badge.svg)](https://stable.melpa.org/#/doom-modeline)
 [![License](http://img.shields.io/:license-gpl3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0.html)
 
-A fancy mode-line from [DOOM Emacs](https://github.com/hlissner/doom-emacs/tree/master/modules/ui/doom-modeline).
+A fast and fancy mode-line which is extracted from [DOOM
-It's integrated to [Centaur Emacs](https://github.com/seagle0128/.emacs.d).
+Emacs](https://github.com/hlissner/doom-emacs/tree/master/modules/ui/doom-modeline),
+but it provides more features and it's much faster.
+
+It's integrated into [Centaur Emacs](https://github.com/seagle0128/.emacs.d) by
+default.
 
 ## Feature
 
-The DOOM modeline was designed for minimalism, and offers:
+The `doom-modeline` was designed for minimalism and fast, and offers:
 
 - A match count panel (for `anzu`, `iedit`, `multi-cusor`, `evil-search` and `evil-substitute`)
 - An indicator for recording a macro
@@ -24,7 +28,8 @@ The DOOM modeline was designed for minimalism, and offers:
 - An indicator for `ryo-modal` state
 - An indicator for remote host.
 - An indicator for current input method
-- Highlight project name in buffer information if `projectile` or `project` is available.
+- Truncated file names, file icon, buffer state and project name in buffer
+  information segment, which is compatible with `projectile` or `project`.
 
 ## Install
 
@@ -51,7 +56,8 @@ In `init.el`,
 This package requires the fonts included with `all-the-icons` to be installed.
 Run `M-x all-the-icons-install-fonts` to do so.
 
-Recommand to use [doom-themes](https://github.com/hlissner/emacs-doom-themes);
+Strongly recommend to use
+[doom-themes](https://github.com/hlissner/emacs-doom-themes) at the same time.
 
 ## Customize
 
@@ -90,13 +96,31 @@ Recommand to use [doom-themes](https://github.com/hlissner/emacs-doom-themes);
 
 ;; Whether show the icon for major mode. It should respect `doom-modeline-icon'.
 (setq doom-modeline-major-mode-icon t)
+```
 
+
+## FAQ
+
+1. I am experiencing the laggy issue on Windows, how to resolve it?
+
+   You need to add this configuration into your init file.
+
+   ``` emacs-lisp
    ;; Don’t compact font caches during GC.
-;; If you are expereicing the laggy issue especially on Windows, please set to
-;; non-nil.
    (setq inhibit-compacting-font-caches t)
    ```
 
+1. A ridiculous path is displayed on mode-line while visiting a symbolink.
+
+    It's the default behaviors of Vanilla Emacs. If you want to display the real
+    names, please put this into your init file.
+
+    ``` emacs-lisp
+    (setq find-file-visit-truename t)
+    ```
+
+    If the file is controlled by vc, refer to `vc-follow-symlinks`.
+
 ## Screenshots
 
 ![modeline](https://github.com/hlissner/doom-emacs/raw/screenshots/ml.png)

doom-modeline.el

@@ -29,19 +29,25 @@
 
 ;;; Commentary:
 ;;
-;; This package offers a modern modeline them which is extraced from DOOM Emacs
+;; This package offers a modern modeline them which is extracted from DOOM Emacs
 ;; (https://github.com/hlissner/doom-emacs/tree/master/modules/ui/doom-modeline).
-;; It's also the part of Centaur Emacs (https://github.com/seagle0128/.emacs.d).
+;; It's also integrated into Centaur Emacs (https://github.com/seagle0128/.emacs.d).
 ;;
-;; The DOOM modeline was designed for minimalism, and offers:
+;; The doom-modeline was designed for minimalism and fast, and offers:
-;; 1. A match count panel (for evil-search, iedit and evil-substitute)
+;; - A match count panel (for evil-search, iedit and evil-substitute)
-;; 2. An indicator for recording a macro
+;; - An indicator for recording a macro
-;; 3. Local python/ruby version in the major-mode
+;; - Local python/ruby version in the major-mode
-;; 4. A customizable mode-line height (see doom-modeline-height)
+;; - A customizable mode-line height (see doom-modeline-height)
-;; 5. An error/warning count segment for flycheck
+;; - An error/warning count segment for flycheck
-;; 6. A workspace number segment for eyebrowse
+;; - A workspace number segment for eyebrowse
-;; 7. A window number segment for winum and window-numbering
+;; - A window number segment for winum and window-numbering
-;; 8. An indicator for evil state
+;; - An indicator for evil state
+;; - An indicator for god state
+;; - An indicator for ryo-modal state
+;; - An indicator for remote host.
+;; - An indicator for current input method
+;; - Truncated file names, file icon, buffer state and project name in buffer
+;;   information segment, which is compatible with projectile or project.
 ;;
 ;; Installation:
 ;; From melpa, `M-x package-install RET doom-modeline RET`.