branch: externals/sql-indent
commit 6778020521aa9fbaa7be56d7359329275d902e13
Author: Alex Harsanyi <[email protected]>
Commit: Alex Harsanyi <[email protected]>
Updated README file
---
README.md | 21 ++++++++++++++-------
1 file changed, 14 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 993c3e7..e57703e 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,18 @@
-# emacs-sql-indent
-Smart indentation for SQL files inside Emacs
+# Smart indentation for SQL files inside Emacs
-To use this mode, byte compile this file, than add the following to your
-~/.emacs.el:
+This is an add-on to the SQL mode that allows smart indentation for SQL code,
+this works like the indentation for C and C++ code: hitting tab indents the
+current line at the correct position.
+
+The actual indentation rules are fully configurable, so they can be adjusted
+to your preferences. See [customize-indentation.md](customize-indentation.md)
+for how to customize the indentation rules.
+
+To install this package, open the file `sql-indent.el` in Emacs and type
+
+ M-x install-package-from-buffer RET
+
+than add the following to your ~/.emacs.el:
(require 'sql-indent)
(add-hook 'sql-mode-hook 'sqlind-setup)
-
-See [customize-indentation.md](customize-indentation.md) for how to customize
-the indentation rules.
