Skip to content

Commit bde5239

Browse files
committed
Merge pull request #12 from ImanMh/master
docs: installation documentation added.
2 parents d52900e + accc1dd commit bde5239

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,34 @@ PHP library for handling chunk uploads. Library contains helper methods for:
1010

1111
This library is compatible with HTML5 file upload library: https://github.com/flowjs/flow.js
1212

13+
Installation
14+
--------------
15+
For easy installation you need to have Composer installed, if you don't please read installation document for Composer at https://getcomposer.org/download/.
16+
17+
Clone this repository first:
18+
```
19+
git clone https://github.com/flowjs/flow-php-server.git
20+
```
21+
Then cd into the cloned directory:
22+
```
23+
cd flow-php-server
24+
```
25+
Use composer to download dependencies and autoload PHP classes.
26+
```
27+
composer install
28+
```
29+
This will create a vendor directory for you which contains an autoload.php file. Create a new php file:
30+
```
31+
touch upload.php
32+
```
33+
Edit upload.php and add these lines:
34+
```php
35+
namespace Flow;
36+
//Path to autoload.php from current location
37+
require_once './flow-php-server/vendor/autoload.php';
38+
```
39+
Note that you could also use ```use``` keyword to add each class inidividually into our current namespace. At this point you are ready to use flow. for more information about how to use it read Basic Usage section.
40+
1341
Basic Usage
1442
--------------
1543
```php

0 commit comments

Comments
 (0)