diff --git a/README.md b/README.md index 233460f..c1cc17e 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,17 @@ [![Coverage Status][ico-coverage]][link-coverage] [![Total Downloads][ico-downloads]][link-downloads] -Slytherin is a simple and extensible PHP micro-framework that tries to achieve a SOLID-based design for creating your next web application. It uses [Composer](https://getcomposer.org/) as the dependency package manager to add, update or even remove external packages. +Slytherin is a simple and extensible PHP micro-framework that tries to achieve a [SOLID-based design](https://en.wikipedia.org/wiki/SOLID) for creating web applications. It uses [Composer](https://getcomposer.org/) as the dependency package manager to add, update or even remove external packages. ## Background -In the current state of PHP ecosystem, the mostly used PHP frameworks are [Symfony](http://symfony.com) and [Laravel](https://laravel.com) which provide great tools for every PHP software engineer. While the said PHP frameworks provide a kitchen-sink solution for every need (e.g., content management system (CMS), CRUD, etc.), they are often overkill, overwhelming at first, or sometimes uses a strict directory structure. +In the current state of PHP ecosystem, the mostly used PHP frameworks like [Symfony](http://symfony.com) and [Laravel](https://laravel.com) provide a great set of tools for every PHP software engineer. While the said PHP frameworks provide a kitchen-sink solution for every need (e.g., content management system (CMS), CRUD, etc.), they are sometimes overkill, overwhelming at first, or sometimes uses a strict directory structure. With this, Slytherin tries an alternative approach to only require the basic tools like [HTTP][link-wiki-http] and [Routing][link-wiki-routing] and let the application evolve from a simple API tool to a full-featured web application. With no defined directory structure, Slytherin can be used to mix and match any structure based on the application's requirements and to encourage the use of open-source packages in the PHP ecosystem. ## Basic Example -Below is an example code for creating a simple Slytherin-based application: +Below is an example code for creating a simple application using Slytherin: ``` php // app/web/index.php @@ -49,7 +49,7 @@ Kindly check the [The First "Hello World"][link-wiki-example] page in the wiki f ## Upgrade Guide -As Slytherin is evolving as a micro-framework, there might be some breaking changes in its internal code. The said changes can be found in the [Upgrade Guide][link-wiki-upgrade] page. +As Slytherin is evolving as a micro-framework, there might be some breaking changes in its internal code during development. The said changes can be found in the [Upgrade Guide][link-wiki-upgrade] page. ## Changelog @@ -75,15 +75,15 @@ $ composer test Slytherin is inspired by the following packages below and their respective implementations. Their contributions improved [my understanding][link-homepage] of writing frameworks and creating application logic from scratch: -* [Awesome PHP!](https://github.com/ziadoz/awesome-php) by [Jamie York](https://github.com/ziadoz) -* [Codeigniter](https://codeigniter.com) by [EllisLab](https://ellislab.com)/[British Columbia Institute of Technology](http://www.bcit.ca) -* [Fucking Small](https://github.com/trq/fucking-small) by [Tony Quilkey](https://github.com/trq) -* [Laravel](https://laravel.com) by [Taylor Otwell](https://github.com/taylorotwell) -* [No Framework Tutorial](https://github.com/PatrickLouys/no-framework-tutorial) by [Patrick Louys](https://github.com/PatrickLouys) -* [PHP Design Patterns](http://designpatternsphp.readthedocs.org/en/latest) by [Dominik Liebler](https://github.com/domnikl) -* [PHP Standard Recommendations](http://www.php-fig.org/psr) by [PHP-FIG](http://www.php-fig.org) -* [Symfony](http://symfony.com) by [SensioLabs](https://sensiolabs.com) -* And lastly, all of the [contributors][link-contributors] in this package. +* [Awesome PHP!](https://github.com/ziadoz/awesome-php) by [Jamie York](https://github.com/ziadoz); +* [Codeigniter](https://codeigniter.com) by [EllisLab](https://ellislab.com)/[British Columbia Institute of Technology](http://www.bcit.ca); +* [Fucking Small](https://github.com/trq/fucking-small) by [Tony Quilkey](https://github.com/trq); +* [Laravel](https://laravel.com) by [Taylor Otwell](https://github.com/taylorotwell); +* [No Framework Tutorial](https://github.com/PatrickLouys/no-framework-tutorial) by [Patrick Louys](https://github.com/PatrickLouys); +* [PHP Design Patterns](http://designpatternsphp.readthedocs.org/en/latest) by [Dominik Liebler](https://github.com/domnikl); +* [PHP Standard Recommendations](http://www.php-fig.org/psr) by [PHP-FIG](http://www.php-fig.org); +* [Symfony](http://symfony.com) by [SensioLabs](https://sensiolabs.com); and +* All of the [contributors][link-contributors] in this package. ## License diff --git a/composer.json b/composer.json index 090245a..982d445 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "rougin/slytherin", - "description": "An extensible and SOLID-based PHP micro-framework.", - "keywords": ["php framework", "php micro-framework", "php package"], + "description": "A simple and extensible PHP micro-framework.", + "keywords": [ "micro-framework", "php-framework" ], "homepage": "https://roug.in/slytherin/", "license": "MIT", "authors":