aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlexander Kiryukhin <a.kiryukhin@mail.ru>2019-08-30 01:29:20 +0300
committerGitHub <noreply@github.com>2019-08-30 01:29:20 +0300
commitb0fba45d68c9ec6c2274ebd61b28ca22bb5deff6 (patch)
tree9f0665b7c9134cd12e3f439fb2a186cac1446822 /README.md
parenta2dca9d668201c37c08b2ecdcee4465c0bea5b57 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index e72a9c3..20d0e3f 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,13 @@
# Collection of checksum algorithms on Go
+Pure Go implementations.
+
## Luhn algorithm
> The Luhn algorithm or Luhn formula, also known as the "modulus 10" or "mod 10" algorithm, named after its creator, IBM scientist Hans Peter Luhn, is a simple checksum formula used to validate a variety of identification numbers, such as credit card numbers, IMEI numbers, National Provider Identifier numbers in the United States, Canadian Social Insurance Numbers, Israel ID Numbers, Greek Social Security Numbers (ΑΜΚΑ), and survey codes appearing on McDonald's, Taco Bell, and Tractor Supply Co. receipts.
[Wikipedia](https://en.wikipedia.org/wiki/Luhn_algorithm)
-Simple implementation on pure Go.
-
### Usage
```golang
@@ -51,7 +51,7 @@ if err != nil {
panic(err)
}
numberWithChecksum := numberWithoutChecksum + checksum
-if err := verhoeff.Generate(numberWithChecksum); err != nil {
+if err := verhoeff.Check(numberWithChecksum); err != nil {
panic(err)
}
```