Skip to content

Commit a8f27a3

Browse files
committed
update readme to detail downloading a release directly
update library version number
1 parent 62c3161 commit a8f27a3

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,30 @@ Send and receive faxes in Ruby with the [InterFAX](https://www.interfax.net/en/d
1010

1111
This library requires PHP 5.5 and above.
1212

13+
### Composer
14+
1315
The preferred method of installation is via [Packagist](http://www.packagist.org) and [Composer](http://www.composer.org). Run the following command to install the package and add it as a requirement to your project's `composer.json`:
1416

1517
```bash
1618
composer require interfax/interfax
1719
```
1820

19-
If you are not using composer with your project currently, the [installation](INSTALLATION.md) docs explain how to use composer for a standalone installation.
21+
### Download the release
22+
23+
You can download the package in its entirety (from 1.0.2 onward). The [Releases](https://github.com/interfax/interfax-php/releases) page lists all stable versions. Download any file
24+
with the name `interFAX-PHP-[RELEASE_NAME].zip` for a package including this library and its dependencies.
25+
26+
Uncompress the zip file you download, and include the autoloader in your project:
27+
28+
```php
29+
require_once '/path/to/interFAX-PHP-[RELEASE_NAME]/vendor/autoload.php';
30+
```
31+
32+
You may wish to rename the release folder to not include the RELEASE_NAME, so that you can drop in future versions without changing the include.
33+
34+
### Build it yourself
35+
36+
The [installation](INSTALLATION.md) docs explain how to use composer to create a standalone installation.
2037

2138
## Getting started
2239

src/Interfax/Client.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
class Client
2222
{
23-
const VERSION = '1.0.1';
23+
const VERSION = '1.0.2';
2424

2525
/**
2626
* @var GenericFactory

0 commit comments

Comments
 (0)