Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Installation documentation added. #12

Merged
merged 3 commits into from
Feb 3, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,34 @@ PHP library for handling chunk uploads. Library contains helper methods for:

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

Installation
--------------
For easy installation you need to have Composer installed, if you don't please read installation document for Composer at https://getcomposer.org/download/.

Clone this repository first:
```
git clone https://github.com/flowjs/flow-php-server.git
```
Then cd into the cloned directory:
```
cd flow-php-server
```
Use composer to download dependencies and autoload PHP classes.
```
composer install
```
This will create a vendor directory for you which contains an autoload.php file. Create a new php file:
```
touch upload.php
```
Edit upload.php and add these lines:
```php
namespace Flow;
//Path to autoload.php from current location
require_once './flow-php-server/vendor/autoload.php';
```
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.

Basic Usage
--------------
```php
Expand Down