add top-level README.mkd

1 files changed, 59 insertions, 0 deletions

diff --git a/composer.json b/composer.json
new file mode 100644
index 0000000..14fad1c
--- /dev/null
+++ b/composer.json
@@ -0,0 +1,59 @@
+{
+  "name": "pablotron/luigi-template",
+  "description": "String emplate library.",
+  "homepage": "https://github.com/pablotron/luigi-template",
+  "license": "MIT",
+
+  "authors": [{
+    "name": "Paul Duncan",
+    "email": "luigi-template@pablotron.org",
+    "homepage": "https://pablotron.org/",
+    "role": "developer"
+  }],
+
+  "require": {
+    "php": "^7"
+  },
+
+  "require-dev": {
+    "phpunit/phpunit": "^7",
+    "phan/phan": "^1.0"
+  },
+
+  "autoload": {
+    "psr-4": {
+      "Pablotron\\Luigi\\": "php/src/"
+    }
+  },
+
+  "scripts": {
+    "test-unit": [
+      "phpunit --bootstrap vendor/autoload.php php/tests"
+    ],
+
+    "test-xml": [
+      "phpunit --bootstrap vendor/autoload.php --log-junit test-results-$(date +%Y%m%d%H%M%S).xml tests"
+    ],
+
+    "test-static": [
+      "phan php/src/*.php"
+    ],
+
+    "test": [
+      "@test-unit",
+      "@test-static"
+    ],
+
+    "docs": [
+      "phpdoc -d php/src -t docs --template=responsive-twig --title=LuigiTemplate"
+    ]
+  },
+
+  "scripts-descriptions": {
+    "test":         "Run all unit tests and the static analyzer.",
+    "test-unit":    "Run all unit tests.",
+    "test-xml":     "Run all unit tests and export the results as XML.",
+    "test-phan":    "Run the static analyzer.",
+    "docs":         "Generate the API documentation."
+  }
+}