Skip to content

Commit

Permalink
Update usage and changelog.
Browse files Browse the repository at this point in the history
  • Loading branch information
irazasyed committed Aug 1, 2018
1 parent 7acd3e2 commit d5e00b2
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,25 @@

All notable changes will be documented in this file.

## 1.2.0 - 2018-08-01

### Added
- Client: `getAll()`, `startAll()`, `stopAll()`, `addFile()`, `addUrl()` methods.
- Torrent Model: `needsMetaData()`, `getDownloadSpeed()`, `getUploadSpeed()`, `getRecheckProgress()` and `getMetadataPercentComplete()`.
- Model: Optional casting toggle argument to the `get()` method.
- Param Builder: Add custom array wrapper.
- Speed and TrunicateNumber Methods to Formatter and Casting.
- More casting types: timestamp, memory, datarate.

### Changed
- Rename Helper to Formatter.
- Rename `bytes` to `size` casting type.
- Refactor `add()` method. No longer fetches duplicate torrent's additional data.
- `seedRatioLimit()` in Torrent Model now supports integer and `Client` value for global seed ratio limit.
- `get()` method now returns collection to be consistent.
- Param Builder: Encodes strings in UTF-8 format as required by Transmission.
- Param Builder: `ids` argument is now fully compatible as per specs to support `recently-active`.

## 1.1.0 - 2018-07-29

- Bugfixes and Optimization.
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ php artisan vendor:publish --provider="Transmission\Laravel\ServiceProvider"
``` php
$transmission = new Transmission\Client($hostname, $port, $username, $password, $httpClientBuilder = null);
$transmission->get(); // Get All Torrents.

// Laravel
$transfers = Transmission::get('recently-active'); //
```

> The SDK supports all the methods listed in specs. For more details, check out [transmission-rpc specs](https://git.io/transmission-rpc-specs).
Expand Down Expand Up @@ -76,7 +79,7 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
[ico-code-quality]: https://img.shields.io/scrutinizer/g/irazasyed/php-transmission-sdk.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/irazasyed/php-transmission-sdk.svg?style=flat-square

[sdk-usage]: https://user-images.githubusercontent.com/1915268/43361217-ffeb2b62-92e6-11e8-8362-51d740593712.png
[sdk-usage]: https://user-images.githubusercontent.com/1915268/43494955-0c47765e-9553-11e8-851e-14139d8bcd0d.png

[link-repo]: https://github.com/irazasyed/php-transmission-sdk
[link-packagist]: https://packagist.org/packages/irazasyed/php-transmission-sdk
Expand Down

0 comments on commit d5e00b2

Please sign in to comment.