Skip to content

Commit 22454af

Browse files
committed
Updated README.
1 parent 870a5de commit 22454af

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,27 @@
1-
# Luhn
1+
# Xi Algorithm
2+
3+
## Luhn
4+
5+
Usage:
26

37
```
4-
$luhn = new Luhn(1234);
5-
$luhn->generate();
8+
use Xi\Algorithm\Luhn;
9+
10+
$luhn = new Luhn();
11+
$luhn->generate(123); // 1230
612
```
713

8-
# Tests
14+
## Running the tests
15+
16+
No dependencies to other libraries exist, but in order to generate an autoloader
17+
first run
918

10-
No dependencies to other libraries exist, but in order to generate an autoloader and run tests, first run
1119
```
1220
composer.phar install --dev
1321
```
22+
23+
and then run the tests with
24+
25+
```
26+
phpunit -c tests
27+
```

0 commit comments

Comments
 (0)