Merge branch 'master' of https://github.com/Kaev/MySQL-To-CSharp

README.md

@@ -1,2 +1,16 @@
 # MySQL-To-CSharp
-Generates C# classes for every table in a MySQL database
+This tool generates C# classes and markup pages for entire MySQL databases (including tables).
+
+# How to use
+Run the program with the following arguments
+
+Parameter | Default value | Description
+--- | --- | ---
+-i | 127.0.0.1 | (optional) IP address of the MySQL server, will use 127.0.0.1 if not specified
+-n | 3306 | (optional) Port number of the MySQL server, will use 3306 if not specified
+-u | root | (optional) Username, will use root if not specified
+-p | | (optional) Password, will use empty password if not specified
+-d | | Database name
+-t | | (optional) Table name, will generate entire database if not specified
+-g | | (optional) Generate a reading constructor and SQL statement output - Activate with -g true
+-m | | (optional) Generate markup pages for database and tables which can be used in wikis - Activate with -m true