From 8d9e2f171022b232633bfa652c24e7de9fcf3160 Mon Sep 17 00:00:00 2001 From: Simon Dann Date: Fri, 1 Dec 2017 12:35:06 +0000 Subject: [PATCH] :memo: fill in readme --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ec976b0..755e4eb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ -# tuppence-boilerplate +

Tuppence Boilerplate

+

An Incredibly small PSR-7 "framework"

-Boilerplate starter project for Tuppence +

+ Latest Stable Version + License +

+ +## About this boilerplate + +This boilerplate wraps [Tuppence](https://github.com/photogabble/tuppence) with some project structure and includes a service provider for the [Plates PHP](http://platesphp.com/) template system and [Docrtine ORM](http://www.doctrine-project.org/projects/orm.html). + +## Install + +Install this project with composer `composer create-project photogabble/tuppence-boilerplate` + +## PSR-7 Support + +Tuppence supports PSR-7 and therefore you will find a lot of PSR-7 middleware libraries work out of the box, for example the below are known to work: + +#### [bryanjhv/slim-session](https://github.com/bryanjhv/slim-session) +Middleware for initiating and managing Sessions. + +#### [akrabat/rka-ip-address-middleware](https://github.com/akrabat/rka-ip-address-middleware) +Middleware that determines the clients IP address and stores it as a `ServerRequest` attribute. + +#### [php-middleware/php-debug-bar](https://github.com/php-middleware/phpdebugbar) +Framework agnostic middleware for attaching [PHP Debug Bar](http://phpdebugbar.com/) to your response.