MYSQLSafe 0.0.9 → 0.1.0

data/README.md

@@ -1,6 +1,13 @@
 # MYSQLSafe
 
-TODO: Write a gem description
+MYSQLSafe abstracts some common MYSQL connection and query actions
+Specifically it 
++ Ensures connection closure
++ Returns an Array (instead of MYSQL object)
++ Rescues and prints errors
++ Sanitizes input
++ Encodes queries
++ Encloses table and column names in backticks (like `this`.`that`)
 
 ## Installation
 
@@ -18,7 +25,23 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+MYSQLSafe allows you to optionally set
++ host
++ database
++ user
++ password
++ encoding
+
+		safe_sql_connect = MYSQLSafe::Base.new()
+		safe_sql_connect.user = 'username'
+		safe_sql_connect.host = 'myhost'
+		safe_sql_connect.password = ENV['MYSQLPASSWORD']
+		safe_sql_connect.database = 'databasename'
+		safe_sql_connect.encoding = 'iso-8859-1' # otherwise defaults to utf-8
+
+MYSQLSafe has one other public function which allows you to pass a MYSQL query
+
+		safe_sql_connect.connect_safe("SELECT * FROM tablename LIMIT 1;")
 
 ## Contributing
 
@@ -27,3 +50,7 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Contact
+
+Shoot me [an email](mailto:scnissen@gmail.com) with any questions or ideas.

data/lib/MYSQLSafe/version.rb

@@ -1,3 +1,3 @@
 module MYSQLSafe
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: MYSQLSafe
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors: