Skip to content

Commit

Permalink
cleaning up readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
minond committed Feb 1, 2014
1 parent 93f53a9 commit baf1e7f
Showing 1 changed file with 2 additions and 38 deletions.
40 changes: 2 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Routes
# Http
======

[![Build Status](https://travis-ci.org/minond/Http.png?branch=master)](https://travis-ci.org/minond/Http)
[![Coverage Status](https://coveralls.io/repos/minond/Http/badge.png?branch=master)](https://coveralls.io/r/minond/Http?branch=master)
Expand All @@ -7,40 +8,3 @@
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/minond/Http/badges/quality-score.png?s=9edf262f6c9fdaf13e38dcd1f50e07dee1011a56)](https://scrutinizer-ci.com/g/minond/Http/)
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/e3ecc490-f8e2-479c-aa5b-d84c4904bd09/mini.png)](https://insight.sensiolabs.com/projects/e3ecc490-f8e2-479c-aa5b-d84c4904bd09)

## Keys

Shared keys:
* format - defaults to html
* method - http method. can also be placed before the url

Controller/action keys:
* namspaces - defaults to app:namespace
* controller
* action

Static resource keys:
* base - base directory
* file - file name without extension

## Samples

```yaml
# controller/action:
/tasks/index:
controller: Tasks
action: index

POST /tasks/create:
controller: Tasks
action: create

/tasks/update:
controller: Tasks
action: update
method: POST

# static resource:
/public/js/{file}.{format}:
base: public/vendor/javascript
```

0 comments on commit baf1e7f

Please sign in to comment.