Skip to content

Commit 8ef73d3

Browse files
committed
Updated readme.
1 parent edc3b7f commit 8ef73d3

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
/.*/
12
/vendor/

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@ ByteFormatter
44
[![Version][Version image]][Releases]
55
[![Build status][Build image]][Build]
66

7-
ByteFormatter is a [PSR-2](http://www.php-fig.org/psr/psr-2/) compliant PHP library that formats byte values as
8-
human-readable strings. An appropriate exponent is calculated automatically such that the value never exceeds the base.
9-
For example, in base 1024, `format(1023)` gives *1023 B* but `format(1024)` gives *1 KiB* instead of *1024 B*.
7+
ByteFormatter formats byte values as human-readable strings. An appropriate exponent is calculated automatically such
8+
that the value never exceeds the base. For example, in base 1024, `format(1023)` gives *1023 B* but `format(1024)` gives
9+
*1 KiB* instead of *1024 B*.
1010

1111
Requirements
1212
------------
1313

14-
- PHP 5.5 and Composer.
15-
- Nothing else and no production dependencies!
14+
- [PHP 5.5](http://php.net/)
15+
- [Composer](https://getcomposer.org/)
16+
- No production dependencies!
1617

1718
Usage
1819
-----
@@ -192,6 +193,6 @@ This library is fully unit tested. Run the tests with `vendor/bin/phpunit test`
192193
in this document can be found in `DocumentationTest`.
193194

194195
[Releases]: https://github.com/ScriptFUSION/ByteFormatter/releases
195-
[Version image]: http://img.shields.io/github/tag/ScriptFUSION/ByteFormatter.svg "Latest version"
196+
[Version image]: https://poser.pugx.org/scriptfusion/byte-formatter/version "Latest version"
196197
[Build]: http://travis-ci.org/ScriptFUSION/ByteFormatter
197198
[Build image]: http://img.shields.io/travis/ScriptFUSION/ByteFormatter.svg "Build status"

src/Byte/ByteFormatter.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ public function format($bytes, $precision = null)
7171
* Formats the specified number with the specified precision.
7272
*
7373
* If precision scaling is enabled the precision may be reduced when it
74-
* contains non-significant digits. If the fractional part is zero it may
75-
* be removed entirely.
74+
* contains insignificant digits. If the fractional part is zero it will
75+
* be completely removed.
7676
*
7777
* @param float $value Number.
7878
* @param $precision Number of fractional digits.

0 commit comments

Comments
 (0)