From 7563c660ad915befc3471e1c333d9ef08e5f715b Mon Sep 17 00:00:00 2001 From: SergeyTsalkov Date: Sun, 9 Jun 2013 17:08:20 -0600 Subject: [PATCH] Update readme to include brief installation section --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 6f65a0f..a564246 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,27 @@ MeekroDB is: * Google's #1 search result for "php mysql library" for over 2 years, with **thousands of deployments worldwide**. * A library with a **perfect security track record**. No bugs relating to security or SQL injection have ever been discovered. +Installation +======== +When you're ready to get started, see the [Quick Start Guide](http://www.meekro.com/quickstart.php) on our website. + +### Manual Setup +Include the `db.class.php` file into your project and set it up like this: + + require_once 'db.class.php'; + DB::$user = 'my_database_user'; + DB::$password = 'my_database_password'; + DB::$dbName = 'my_database_name'; + +### Composer +Add this to your `composer.json` + + { + "require": { + "sergeytsalkov/meekrodb": "*" + } + } + Code Examples ======== ### Grab some rows from the database and print out a field from each row.