diff --git a/docs/flow.md b/docs/flow.md index bab54ad..fdcea6b 100644 --- a/docs/flow.md +++ b/docs/flow.md @@ -5,9 +5,9 @@ This is the Penny's flowchart. It is a event-based middleware. There is only one main event that turns into the application flow. -Dispatcher tries to match router and request, if this metch exists it returns the result, if not, or in case of problems it triggers an `ERROR_DISPATCH` event. +Dispatcher tries to match router and request, if this match exists it returns the result, if not, or in case of problems it triggers an `ERROR_DISPATCH` event. -There are two possibile kind of problems: +There are two possible kind of problems: * Route doesn't exist, an `GianArb\Penny\Exception\RouteNotFound` Exception is thrown; * Route exists but the HTTP Method hasn't been matched, an `GianArb\Penny\Exception\MethodNotAllowed` Exception is thrown; @@ -22,7 +22,7 @@ $r->addRoute('GET', '/', ['PennyApp\Controller\IndexController', 'index']); At this point the system triggers an event called `indexcontroller.index` with zero priority and execute the route callback. -All listeners attached after and before it will be called correcly until the framework returns response, +All listeners attached after and before it will be called correctly until the framework returns response, if an exception is thrown it will trigger an event named `indexcontroller.index_error`. The most common way to manage all exceptions is: diff --git a/docs/getting-started.md b/docs/getting-started.md index c21fd09..8de7f01 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -42,10 +42,10 @@ This tutorial proposal is:   └── index.php ``` -- `app` contains application files. -- `config` is the folder from wich penny loads dependency injection configurations by default. +- `app` contains application files. +- `config` is the folder from which penny loads dependency injection configurations by default. -Every application has an entrypoint, `public/index.php` is our. +Every application has an entry point, `public/index.php` is our. ```php // /public/index.php @@ -69,7 +69,7 @@ composer install # WebServer -Of courese you can use your favourite webserver. Here are just a few examples +Of courese you can use your favorite web server. Here are just a few examples ## PHP In develop I use the PHP Internal Server. You go in the root of project and run it. @@ -138,7 +138,7 @@ At the moment the default DiC library is PHP-DI and in this tutorial I use it. The default path where penny look for configuration files is the `config` directory. Files whose name match the `*.php` pattern are loaded first and then it loads files whose name match the `*.local.php` pattern. -This strategy is useful to do configuration overriding for things like database credentials or exteranl services api keys. +This strategy is useful to do configuration overriding for things like database credentials or external services api keys. The first step is to define a routing strategy, at the moment I'm using [nikic/FastRoute](https://github.com/nikic/FastRoute) and, as the name state, it is very fast and surprisingly easy to use. @@ -615,4 +615,4 @@ class IndexController That's all for now, we really need your feedback to improve Penny. -**SOCIAL-ALERT:** Feedback is important to us. If you want to share your feedback about this document or about Penny, please do it opening an issue or discussing with us on Twitter using the [#pennyphp hashtag](https://twitter.com/hashtag/pennyphp?src=hash) +**SOCIAL-ALERT:** Feedback is important to us. If you want to share your feedback about this document or about Penny, please do it opening an issue or discussing with us on Twitter using the [#pennyphp hashtag](https://twitter.com/hashtag/pennyphp?src=hash) diff --git a/docs/index.md b/docs/index.md index 965d6c4..110c9ee 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,14 +3,14 @@ Penny is a framework that helps you to build middleware applications, it is base # Perfect Libraries PHP has a very powerful open source ecosystem. There are a lot of developers and a lot of companies that work and put effort on some of the best libraries with wich we can use to build our applications. -Penny was born to manage integration between your favourite libraries and it does not force you to use nothing you don't want to. +Penny was born to manage integration between your favorite libraries and it does not force you to use nothing you don't want to. # The Core Penny is very easy its core is built using [PHP-DI](http://php-di.org) a strong dependency injection library. In its base implementation it uses [nikic/FastRoute](https://github.com/nikic/FastRoute) a fast regular expression based router. # The cost of freedom -This freedom requires a strong knowledge of the Dependency Injection pattern and a deep understanding of the open source ecosystem is essential to choose the perfect mix of libraries with wich build your application. +This freedom requires a strong knowledge of the Dependency Injection pattern and a deep understanding of the open source ecosystem is essential to choose the perfect mix of libraries with which build your application. Here we put a list of implementation examples to help you with your development process: diff --git a/docs/skeleton-application.md b/docs/skeleton-application.md index 854e63c..82ee534 100644 --- a/docs/skeleton-application.md +++ b/docs/skeleton-application.md @@ -23,7 +23,7 @@ The Penny Skeleton Application aims to be the starting point to bootstrap a typi The Penny skeleton application is [hosted on GitHub](https://github.com/gianarb/penny-classic-app) -The most common ways to get it are: +The most common ways to get it are: ### Via git clone @@ -49,8 +49,8 @@ PHP dependencies and autoloading are managed trough composer. [New to composer?] ## Build assets -Javascript frontend dependencies are managed trough [bower](http://bower.io/) and built using [grunt](http://gruntjs.com). -Grunt and other build tools are +Javascript front end dependencies are managed trough [bower](http://bower.io/) and built using [grunt](http://gruntjs.com). +Grunt and other build tools are **Note:** *The following commands must be issued in the skeleton application folder*, @@ -91,7 +91,7 @@ php -S 0.0.0.0:80 -t public If you want to use it in production you have to: disable error reporting, persist logs, disable Z-Ray, raise limits and fine tune your configurations. The `penny-classic-app` repository contains a `docker-compose.yml.dist` file which currently configures two containers, one -running the NGINX webserver and one running php-fpm. +running the NGINX web server and one running php-fpm. This file should work as is but *must be renamed* into `docker-compose.yml`. You can modify if you need something specific for your system like paths, ip addresses, ports, additional services (databases, queues, caching layers) and so on. Remember that the docker-compose.yml file is in `.gitignore` since this is very specific to the current installation. diff --git a/docs/use-case.md b/docs/use-case.md index c80a2b2..bf86d44 100644 --- a/docs/use-case.md +++ b/docs/use-case.md @@ -11,4 +11,4 @@ It uses [thephpleague/plates](https://github.com/thephpleague/plates) as templat # Applications -* [currency-fair](https://github.com/gianarb/currency-fair-codetest) if you look at the backend directory there's an API system implementated using Penny. It uses [predis](https://github.com/nrk/predis) and few ZF2 components. +* [currency-fair](https://github.com/gianarb/currency-fair-codetest) if you look at the backend directory there's an API system implemented using Penny. It uses [predis](https://github.com/nrk/predis) and few ZF2 components.