read me fill

akriventsev · Oct 28, 2020 · fa8855b · fa8855b
1 parent 45d7f4b
commit fa8855b
Showing 1 changed file with 26 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,26 @@
-# go-card
+
+# 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()