Skip to content
This repository was archived by the owner on Oct 30, 2024. It is now read-only.

Commit 7e1a7f2

Browse files
committed
Merge pull request repejota#19 from repejota/feature/issue_18
Fixes repejota#18: Add installation instructions on README file
2 parents 8be1089 + 7680b0c commit 7e1a7f2

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,30 @@ Requirements
2828
Usage
2929
-----
3030

31+
### Installation
32+
33+
Let's start by downloading composer into our project dir:
34+
```
35+
curl -O http://getcomposer.org/composer.phar
36+
chmod +x composer.phar
37+
```
38+
39+
Now let's tell composer about our project's dependancies, in this case, PHPNats. The way we do this is by creating a composer.json file, and placing it in the root folder of our project, right next to composer.phar
40+
41+
```
42+
{
43+
"require": {
44+
"repejota/nats": "master"
45+
}
46+
}
47+
```
48+
Let's let Composer work its magic:
49+
```
50+
php composer.phar install
51+
```
52+
Composer will download all the dependencies defined in composer.json, and prepare all the files needed to autoload them.
53+
54+
3155
### Basic Usage
3256

3357
```php
@@ -48,14 +72,21 @@ $client->subscribe("foo", $callback);
4872
$client->wait(1);
4973
```
5074

75+
5176
Developer's Information
5277
-----------------------
5378

79+
### Releases
80+
81+
[Latest stable](https://github.com/repejota/phpnats/tree/master)
82+
[Latest dev](https://github.com/repejota/phpnats/tree/develop)
83+
5484
### Tests
5585

5686
Tests are in the `tests` folder.
5787
To run them, you need `PHPUnit` and execute `make test`.
5888

89+
5990
### Code Quality
6091

6192
We are using [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer/docs)

0 commit comments

Comments
 (0)