Load version number from file

[php-sqllint.git] / README.rst

diff --git a/README.rst b/README.rst
index bca5a30c607df3c552f020b9569f31237fb987c8..d4ae83c2c487d6dd10dc7fc4357bf50688f30348 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -6,12 +6,15 @@ Command line tool to validate (syntax check) SQL files.
 Primarily for MySQL ``.sql`` files.
 
 Can be used in git pre-commit hooks to catch errors.
+Use it from your shell, offline and without any SQL server.
+
+You can also use it to format SQL queries.
 
 
 =====
 Usage
 =====
-::
+Syntax check::
 
     $ php-sqllint tests/files/create-missingcomma.sql 
     Checking SQL syntax of tests/files/create-missingcomma.sql
@@ -27,6 +30,36 @@ Emacs mode::
     tests/files/create-noname.sql:1.13:Error: At least one column definition was expected.
 
 
+Formatting::
+
+    $ php-sqllint --format tests/files/select-unformatted.sql
+    SELECT
+      id,
+      NAME,
+      url
+    FROM
+      users
+    WHERE
+      DATE > NOW() AND id != 0
+    ORDER BY NAME
+    LIMIT 10
+
+
+Syntax highlighting
+===================
+ANSI colors are applied automatically when not piping; you can use the
+``--highlight`` option to override the automatism.
+
+``--highlight`` option values:
+
+``none``
+  No highlighting. Use it to disable automatic highlighting
+``ansi``
+  ANSI escape codes for your shell
+``html``
+  HTML tags
+
+
 ====
 Bugs
 ====
@@ -60,6 +93,14 @@ Now you can use ``./bin/php-sqllint`` without building the phar yourself.
 ========
 Building
 ========
+
+Preparation
+===========
+1. Write new version number into ``VERSION``
+
+
+Create the release
+==================
 You'll need `phing`__, the PHP build tool::
 
     $ phing