Skip to content

Commit bea1635

Browse files
committed
Complited README file
1 parent ddd3cb9 commit bea1635

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,40 @@
11
# PHP Form
22
[![Build Status](https://travis-ci.org/dipcode-software/php-form.svg?branch=master)](https://travis-ci.org/dipcode-software/php-form)
33
[![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)
4-
[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](http://www.opensource.org/licenses/MIT)
4+
[![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](http://www.opensource.org/licenses/MIT)
55

6-
PHP class for form handling abstraction.
6+
PHP class for form handling abstraction inspired in Django Framework forms.
7+
8+
## Instalation
9+
10+
Library can be installed using Composer like so:
11+
12+
```shell
13+
$ composer require dipcode/phpform
14+
```
15+
16+
## Starting development
17+
Start by cloning the repo:
18+
19+
```shell
20+
$ git clone git@github.com:dipcode-software/php-form.git
21+
$ cd php-form
22+
```
23+
24+
Install the composer dependencies:
25+
```shell
26+
$ composer install
27+
```
28+
29+
### Running the tests
30+
To run tests, unit and style tests, just run:
31+
32+
```shell
33+
$ composer test
34+
```
35+
36+
### Coding Style
37+
38+
Largely PSR-2 compliant:
39+
40+
(https://raw.githubusercontent.com/php-fig/fig-standards/master/accepted/PSR-2-coding-style-guide.md)[https://raw.githubusercontent.com/php-fig/fig-standards/master/accepted/PSR-2-coding-style-guide.md]

0 commit comments

Comments
 (0)