Skip to content

Commit 27bb5ab

Browse files
authored
Update README.md (#30)
* Update README.md * Update README.md * Update README.md * Update README.md
1 parent 6d66a5c commit 27bb5ab

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

README.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,7 @@
33
[![Build Status](https://travis-ci.org/Ekman/Luhn-Algorithm.svg?branch=master)](https://travis-ci.org/Ekman/Luhn-Algorithm)
44
[![Coverage Status](https://coveralls.io/repos/github/Ekman/Luhn-Algorithm/badge.svg)](https://coveralls.io/github/Ekman/Luhn-Algorithm)
55

6-
This is an implementation of the Luhn Algorithm for PHP 7.0 and above. The Luhn Algorithm is
7-
used to validate things like credit cards and national identification numbers.
8-
More information on the algorithm can be found at [Wikipedia](http://en.wikipedia.org/wiki/Luhn_algorithm).
6+
This is a zero dependency implementation of the Luhn Algorithm for PHP 7.0 and above. The Luhn Algorithm is used to validate things like credit cards and national identification numbers. More information on the algorithm can be found at [Wikipedia](http://en.wikipedia.org/wiki/Luhn_algorithm).
97

108
## Installation
119

@@ -25,11 +23,9 @@ In order to instantiate a new instance of the library, use the factory:
2523
$luhn = LuhnAlgorithmFactory::create();
2624
```
2725

28-
You can find [the public interface of the library in the `LuhnAlgorithmInterface`](src/Contract/LuhnAlgorithmInterface.php).
26+
You can find [the library facade in the `LuhnAlgorithmInterface.php` file](src/Contract/LuhnAlgorithmInterface.php).
2927

30-
[The `Number` class](src/Number.php) is a container class that holds the actual number and the check digit. It does no validation
31-
nor does it calculate the check digit. To simplify the process of validating a number you can use the
32-
named constructor `Number::fromString()` like this:
28+
[The `Number` class](src/Number.php) is a container class that holds the actual number and the check digit. It does no validation nor does it calculate the check digit. It exists to clearly separate the number from the check digit and to define when the check digit exists or not. To simplify the process of validating a number you can use the named constructor `Number::fromString()` like this:
3329

3430
```php
3531
use Nekman\LuhnAlgorithm\Number;

0 commit comments

Comments
 (0)