Merge pull request #219 from karllhughes/master

Composer support

Author: mevdschee

.gitignore

@@ -3,3 +3,7 @@
 .settings/
 phpunit.phar
 tests/config.php
+.idea/
+vendor
+composer.lock
+.DS_Store

README.md

@@ -21,6 +21,8 @@ Related projects:
 
 This is a single file application! Upload "api.php" somewhere and enjoy!
 
+Alternatively, you can use [Composer](https://getcomposer.org/). See the _Composer Installation_ section below.
+
 ## Limitations
 
   - Primary keys should either be auto-increment (from 1 to 2^53) or UUID
@@ -1028,6 +1030,39 @@ string(6) "/posts"
 
 If it does not, something is wrong on your hosting environment.
 
+## Composer Installation
+
+- Include the library in your composer.json file:
+
+```json
+{
+    "require": {
+        "mevdschee/php-crud-api": "dev-master"
+    }
+}
+```
+
+- Run `composer install`
+- Use the library in your own code:
+
+```php
+<?php
+
+include './vendor/autoload.php';
+
+// DB Connection
+$api = new PHP_CRUD_API(array(
+ 	'dbengine'=>'MySQL',
+ 	'hostname'=>'localhost',
+ 	'username'=>'',
+ 	'password'=>'',
+	'database'=>'',
+	'charset'=>'utf8'
+));
+$api->executeCommand();
+
+```
+
 ## License
 
 MIT

composer.json

@@ -0,0 +1,34 @@
+{
+  "name": "mevdschee/php-crud-api",
+  "type": "library",
+  "description": "Single file PHP script that adds a REST API to a SQL database.",
+  "keywords": [
+    "api-server",
+    "restful",
+    "mysql",
+    "geospatial",
+    "sql-server",
+    "postgresql",
+    "php-api",
+    "postgis",
+    "crud",
+    "rest-api",
+    "openapi",
+    "swagger"
+  ],
+  "homepage": "https://github.com/mevdschee/php-crud-api",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Maurits van der Schee",
+      "email": "maurits@vdschee.nl",
+      "homepage": "https://github.com/mevdschee"
+    }
+  ],
+  "require": {
+    "php": ">=5.6.0"
+  },
+  "autoload": {
+    "files": ["api.php"]
+  }
+}