From fa8855bc32cfc7d0806e60a535df9d957675c0d9 Mon Sep 17 00:00:00 2001 From: Alexander Kriventsev Date: Wed, 28 Oct 2020 21:50:23 +0300 Subject: [PATCH] read me fill --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2bf8b25..464d3e8 100644 --- a/README.md +++ b/README.md @@ -1 +1,26 @@ -# go-card \ No newline at end of file + +# go-card + +Basic credit card structure with validation using the [Luhn algorithm](http://en.wikipedia.org/wiki/Luhn_algorithm) + + +## Installation + +```bash +go get github.com/anaximen/go-card +``` + +## Quick Start + +```go +// Initialize a new card: +card,err := card.NewCard("4716339239466898", "334", 2023, 12, "Ivanov Ivan") + +if err!= nil { + fmt.Print(err) +} +... + +expired := card.Expired() + +maskedNumber := card.MaskedNumber() \ No newline at end of file