Merge pull request #19 from dipcode-software/feat/docs

Feat/docs

Author: srtab

composer.json

@@ -1,8 +1,11 @@
 {
   "name": "dipcode/php-form",
-  "description": "PHP class for form handling abstraction.",
+  "description": "Full featured form engine library.",
   "license": "MIT",
   "homepage": "https://github.com/dipcode-software/php-form",
+  "keywords": [
+    "forms"
+  ],
   "authors": [
     {
       "name": "Dipcode",

deploy/deploy.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+source deploy/env/bin/activate && \
+    pip install -r deploy/docs-requirements.txt && \
+    mkdocs build && \
+    tar -zcvf phpform.tar.gz -C site . && \
+    curl -X POST -H "Content-Type: multipart/form-data" -H "Api-Key: ${1}" -F "archive=@phpform.tar.gz" https://alexandriadocs.io/api/v1/projects/upload/ && \
+    rm phpform.tar.gz

docs/requirements.txt renamed to deploy/docs-requirements.txt

@@ -0,0 +1,10 @@
+# Welcome to PHPForm documentation
+[![Build Status](https://travis-ci.org/dipcode-software/php-form.svg?branch=master)](https://travis-ci.org/dipcode-software/php-form)
+[![Coverage Status](https://coveralls.io/repos/github/dipcode-software/php-form/badge.svg?branch=master)](https://coveralls.io/github/dipcode-software/php-form?branch=master)
+[![Latest Stable Version](https://poser.pugx.org/dipcode/php-form/v/stable)](https://packagist.org/packages/dipcode/php-form)
+[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](http://www.opensource.org/licenses/MIT)
+
+PHP class for form handling abstraction inspired in the fantastic Django Framework Forms.
+
+## Requirements
+PHPForm v1.1.0 requires PHP 7. Using the latest version of PHP is highly recommended.