Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chriskapp committed Dec 29, 2015
1 parent a2637af commit abf656a
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,35 @@ PSX Framework

PSX is a framework written in PHP to create RESTful APIs. It provides tools to
handle routing, API versioning, data transformation, authentication,
documentation and testing. With PSX you can easily build an REST API around an
documentation and testing. With PSX you can easily build a REST API around an
existing application or create a new one from scratch. More informations at
http://phpsx.org
[phpsx.org](http://phpsx.org/)

## Requirements

> >= PHP 5.4 or HHVM 3.2.0
## Installation

You have three options in order to install PSX. Either download a current
release from github
The best option is to install the PSX sample project via composer

https://github.com/k42b3/psx/releases
php composer.phar create-project psx/sample .

install the PSX sample project via composer
it is also possible to require PSX as dependency in your composer.json

php composer.phar create-project psx/sample .
"psx/psx": "~1.1"

or require PSX as dependency in your composer.json
you can also download a current release from github which already includes all
vendor libraries in case composer is not available

"psx/psx": "~1.0"
https://github.com/k42b3/psx/releases

## Documentation
check out the [get started](http://phpsx.org/get-started) guide for more
detailed instructions.

The official manual is available at http://psx.readthedocs.org/
## Documentation

For documentation please take a look at [phpsx.org](http://phpsx.org/) or the
[official manual](http://psx.readthedocs.org/)

[![Build Status](https://travis-ci.org/k42b3/psx.png)](https://travis-ci.org/k42b3/psx)

0 comments on commit abf656a

Please sign in to comment.