Add README.md and badges

xunto · Nov 19, 2016 · 3c8aab4 · 3c8aab4
1 parent 94de295
commit 3c8aab4
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+Alfresco-Control
+=============
+
+[![Coverage Status](https://coveralls.io/repos/github/xunto/alfresco-control/badge.svg?branch=travis_configuration)](https://coveralls.io/github/xunto/alfresco-control?branch=travis_configuration)
+
+##Description
+Simple alfresco api wrapper created for personal use. Only process creating and fetching
+are currently supported. I do not guarantee further development but I accept pull requests.
+
+##Requirements
+ - php: >=5.6.0,
+ - guzzle: ^6.2
+
+##Installation
+```
+composer require xunto/alfresco-control
+```
diff --git a/composer.json b/composer.json
@@ -3,6 +3,7 @@
   "version": "0.0.1",
   "type": "library",
   "license": "MIT",
+  "description": "Simple alfresco api wrapper.",
   "authors": [
     {
       "name": "xunto",