Skip to content

Commit 1871c50

Browse files
spawnialstrojny
authored andcommitted
Simplify README and fix installation (#185)
The version number was out of date. The way the installation is written now, it is a single command and can never get out of date. I also unified some of the formatting along the way. Thanks for a great project!
1 parent 7a6dc26 commit 1871c50

1 file changed

Lines changed: 22 additions & 24 deletions

File tree

README.md

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,43 +11,41 @@ collection](http://www.scala-lang.org/archives/downloads/distrib/files/nightly/d
1111
[Dojo’s array functions](http://dojotoolkit.org/reference-guide/quickstart/arrays.html) and
1212
[Underscore.js](http://underscorejs.org/)
1313

14-
- Works with arrays and everything implementing interface `Traversable`
15-
- Consistent interface: for functions taking collections and callbacks, first parameter is always the collection, then the callback.
16-
Callbacks are always passed `$value`, `$index`, `$collection`. Strict comparison is the default but can be changed
17-
- Calls 5.3 closures as well as usual callbacks
18-
- All functions reside in namespace `Functional` to not raise conflicts with any other extension or library
14+
- Works with arrays and everything implementing interface `Traversable`
15+
- Consistent interface: for functions taking collections and callbacks, first parameter is always the collection, then the callback.
16+
Callbacks are always passed `$value`, `$index`, `$collection`. Strict comparison is the default but can be changed
17+
- Calls 5.3 closures as well as usual callbacks
18+
- All functions reside in namespace `Functional` to not raise conflicts with any other extension or library
1919

2020
[![Functional Comic](http://imgs.xkcd.com/comics/functional.png)](http://xkcd.com/1270/)
2121

22-
## Installation with composer
22+
## Installation
2323

24-
Put the require statement for `functional-php` in your `composer.json` file and run `php composer.phar install`:
24+
Run the following command in your project root:
2525

26-
```json
27-
{
28-
"require": {
29-
"lstrojny/functional-php": "~1.2"
30-
}
31-
}
32-
```
26+
composer require lstrojny/functional-php
3327

3428
## Docs
29+
3530
[Read the docs](docs/functional-php.md)
3631

37-
## Installing dependencies
38-
To install all dependencies type `composer install`
32+
## Contributing
3933

40-
## Running the test suite
41-
To run the test suite type `composer run tests`
34+
1. Fork and `git clone` the project
35+
2. Install dependencies via `composer install`
36+
3. Run the tests via `composer run tests`
37+
4. Write code and create a PR
4238

4339
## Mailing lists
44-
- General help and development list: http://groups.google.com/group/functional-php
45-
- Commit list: http://groups.google.com/group/functional-php-commits
40+
41+
- General help and development list: http://groups.google.com/group/functional-php
42+
- Commit list: http://groups.google.com/group/functional-php-commits
4643

4744
## Thank you
48-
- [Richard Quadling](https://github.com/RQuadling) and [Pierre Joye](https://github.com/pierrejoye) for Windows build
45+
46+
- [Richard Quadling](https://github.com/RQuadling) and [Pierre Joye](https://github.com/pierrejoye) for Windows build
4947
help
50-
- [David Soria Parra](https://github.com/dsp) for various ideas and the userland version of `Functional\flatten()`
51-
- [Max Beutel](https://github.com/maxbeutel) for `Functional\unique()`, `Functional\invoke_first()`,
48+
- [David Soria Parra](https://github.com/dsp) for various ideas and the userland version of `Functional\flatten()`
49+
- [Max Beutel](https://github.com/maxbeutel) for `Functional\unique()`, `Functional\invoke_first()`,
5250
`Functional\invoke_last()` and all the discussions
53-
- The people behind [Travis CI](http://travis-ci.org/) for continuous integration
51+
- The people behind [Travis CI](http://travis-ci.org/) for continuous integration

0 commit comments

Comments
 (0)