From 68b0ec2a30f6563cea6d5eb1ea6676de3f833800 Mon Sep 17 00:00:00 2001
From: David Landell <david@landells.com>
Date: Sat, 20 Oct 2018 14:43:51 +0200
Subject: [PATCH] Add documentation for position number alignment

---
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 42 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 2842d0f..b175530 100644
--- a/README.md
+++ b/README.md
@@ -29,23 +29,17 @@ load path and add this to `init.el`
 
 ``` el
 (require 'rg)
-(rg-enable-default-bindings (kbd "M-s"))
+(rg-enable-default-bindings)
 ```
 
-`rg` and friends is an autoloaded symbol so it's also possible to
-defer loading if you have autoloading setup.
+`rg` and friends are autoloaded symbols which means it's also possible
+to defer loading if you have autoloading setup.
 
 ### wgrep
 
-The default configuration of this package is compatible with `wgrep`.
-If grouped mode and/or show columns is enabled you need to install the
-[wgrep-ag](http://melpa.org/#/wgrep-ag) package from MELPA and
-configure it like this:
-
-``` el
-(add-hook 'rg-mode-hook 'wgrep-ag-setup)
-```
-
+This package use [wgrep](https://github.com/mhayashi1120/Emacs-wgrep)
+for doing changes to matched files from the rg results buffer. No
+setup is needed.
 
 
 ## Usage
@@ -193,6 +187,42 @@ Controls if the search info header is shown in the result
 buffer. This is enabled by default but can be disabled by setting this
 variable to `nil`.
 
+### Position numbers alignment
+It's possible to control how the line and column numbers are displayed
+in the result buffer.
+
+Example settings:
+``` emacs-lisp
+(setq rg-align-position-numbers t)
+(setq rg-align-line-number-field-length 3)
+(setq rg-align-column-number-field-length 3)
+(setq rg-align-line-column-separator "#")
+(setq rg-align-position-content-separator "|")
+```
+Will yield the following format:
+
+```
+  1#  2|match1
+888# 10|match2
+```
+
+#### `rg-align-position-numbers`
+Setting this to `t` will align line and column numbers in columns
+padded with whitespace.
+
+#### `rg-align-line-number-field-length`
+Defines the length of the line number field.
+
+#### `rg-align-column-number-field-length`
+Defines the length of the column number field.
+
+#### `rg-align-line-column-separator`
+Separator string used between line and column numbers.
+
+#### `rg-align-position-content-separator`
+Separator string used between the position numbers and matched
+content.
+
 ### `rg-define-toggle`
 This is a macro that can be used to define custom `ripgrep` flag
 toggling functions in the rg result buffer. The macro takes the flag