Skip to content

Commit 685060b

Browse files
committed
Include more detailed information in the README.md
1 parent 5142916 commit 685060b

File tree

3 files changed

+24
-7
lines changed

3 files changed

+24
-7
lines changed

.semver

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
22
:major: 1
33
:minor: 0
4-
:patch: 3
4+
:patch: 4
55
:special: ''

README.md

+22-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# PHP Bootstrap (base / project skeleton)
22

33
[![Latest Version on Packagist][ico-version]][link-packagist]
4-
[![Software License][ico-license]](LICENSE.md)
4+
[![Software License][ico-license]][link-license]
55
[![Build Status][ico-travis]][link-travis]
66
[![Quality Score][ico-code-quality]][link-code-quality]
77
[![Total Downloads][ico-downloads]][link-downloads]
@@ -10,7 +10,17 @@
1010

1111
This is a repository intended to serve as a starting point if you want to bootstrap a project in PHP.
1212

13-
It could be useful if you want to start from scratch a kata or a little exercise or project.
13+
It could be useful if you want to start from scratch a kata or a little exercise or project. The idea is that you don't have to worry about the boilerplate, just run `composer create-project codelytv/php-bootstrap your-kata-name` and there you go:
14+
* Latest versions of PHP and PHPUnit in order to practice with them
15+
* Best practices applied:
16+
* [`README.md`][link-readme] (badges included)
17+
* [`LICENSE`][link-license]
18+
* [`composer.json`][link-composer-json]
19+
* [`phpunit.xml`][link-phpunit]
20+
* [`.editorconfig`][link-editorconfig]
21+
* [`.travis.yml`][link-travis]
22+
* [`.scrutinizer.yml`][link-scrutinizer]
23+
* Some useful resources to start coding
1424

1525
## How To Start
1626

@@ -44,20 +54,20 @@ It could be useful if you want to start from scratch a kata or a little exercise
4454
* [Martin Fowler Refactorings catalog](http://refactoring.com/catalog/)
4555
* [CodelyTV Refactoring videos (Spanish)](http://codely.tv/tag/refactoring/)
4656

47-
# Other programming languages
57+
## Other programming languages
4858

4959
* [PHP](https://github.com/CodelyTV/php-bootstrap)
5060
* [Scala](https://github.com/CodelyTV/scala_bootstrap)
5161

5262
## About
5363

54-
This hopefully helpful utility has been developed by [CodelyTV][link-author] and [Contributors][link-contributors].
64+
This hopefully helpful utility has been developed by [CodelyTV][link-author] and [contributors][link-contributors].
5565

5666
We'll try to maintain this project as simple as possible, but Pull Requests are welcomed!
5767

5868
## License
5969

60-
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
70+
The MIT License (MIT). Please see [License File][link-license] for more information.
6171

6272
[ico-version]: https://img.shields.io/packagist/v/codelytv/php-bootstrap.svg?style=flat-square
6373
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
@@ -71,3 +81,10 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
7181
[link-downloads]: https://packagist.org/packages/codelytv/php-bootstrap
7282
[link-author]: https://github.com/CodelyTV
7383
[link-contributors]: ../../contributors
84+
[link-composer-json]: composer.json
85+
[link-readme]: README.md
86+
[link-license]: LICENSE.md
87+
[link-phpunit]: phpunit.xml
88+
[link-editorconfig]: .editorconfig
89+
[link-travis]: .travis.yml
90+
[link-scrutinizer]: .scrutinizer.yml

composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "codelytv/php-bootstrap",
33
"description": "Starting point if you want to bootstrap a project in PHP.",
4-
"version": "1.0.3",
4+
"version": "1.0.4",
55
"type": "project",
66
"keywords": [
77
"bootstrap",

0 commit comments

Comments
 (0)