Skip to content

Commit 222d57c

Browse files
committed
README updates
1 parent 07c27f0 commit 222d57c

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,39 @@ This interface is meant for the general public to use with PHongo,
88
and will serve as the default reference interface when creating other bindings.
99

1010

11+
## Documentation
12+
- http://bjori.github.io/phongo/
13+
14+
# Installation
15+
16+
As PHongo CRUD is an abstraction layer for PHongo, it naturally requires [PHongo to be
17+
installed](http://bjori.github.io/phongo/#installation):
18+
19+
$ wget https://github.com/bjori/phongo/releases/download/0.1.2/phongo-0.1.2.tgz
20+
$ pecl install phongo-0.1.2.tgz
21+
$ echo "extension=phongo.so" >> `php --ini | grep "Loaded Configuration" | sed -e "s|.*:\s*||"`
22+
23+
The best way to then install PHongo CRUD is via [composer](https://getcomposer.org/)
24+
by adding the following to
25+
[composer.json](https://getcomposer.org/doc/01-basic-usage.md#composer-json-project-setup):
26+
27+
```json
28+
"repositories": [
29+
{
30+
"type": "vcs",
31+
"url": "https://github.com/bjori/phongo-crud"
32+
}
33+
],
34+
"require": {
35+
"ext-phongo": ">=0.1.2",
36+
"bjori/phongo-crud": "dev-master"
37+
}
38+
```
39+
40+
and then running
41+
42+
```shell
43+
$ composer install
44+
```
45+
46+
## Reporting tickets

0 commit comments

Comments
 (0)