From 27bb5abaf7975779ea56371d2e92325e84f4a2f6 Mon Sep 17 00:00:00 2001 From: Niklas Ekman Date: Thu, 23 Apr 2020 22:04:55 +0200 Subject: [PATCH] Update README.md (#30) * Update README.md * Update README.md * Update README.md * Update README.md --- README.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d00ea9a..45c1a81 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,7 @@ [![Build Status](https://travis-ci.org/Ekman/Luhn-Algorithm.svg?branch=master)](https://travis-ci.org/Ekman/Luhn-Algorithm) [![Coverage Status](https://coveralls.io/repos/github/Ekman/Luhn-Algorithm/badge.svg)](https://coveralls.io/github/Ekman/Luhn-Algorithm) -This is an 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). +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). ## Installation @@ -25,11 +23,9 @@ In order to instantiate a new instance of the library, use the factory: $luhn = LuhnAlgorithmFactory::create(); ``` -You can find [the public interface of the library in the `LuhnAlgorithmInterface`](src/Contract/LuhnAlgorithmInterface.php). +You can find [the library facade in the `LuhnAlgorithmInterface.php` file](src/Contract/LuhnAlgorithmInterface.php). -[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. To simplify the process of validating a number you can use the -named constructor `Number::fromString()` like this: +[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: ```php use Nekman\LuhnAlgorithm\Number;