From a8fbf0905b853ae4d04e80da29949b7717520217 Mon Sep 17 00:00:00 2001
From: Kyle Sin Lynn <kylesinlynn@gmail.com>
Date: Mon, 23 Jan 2023 12:01:27 +0630
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=83=20docs:=20create=20readme=20for=20?=
 =?UTF-8?q?uses?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7fb0994
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# 💳 Credit Card Validator
+> This python package is inspired by [Luhn](https://github.com/amm834/luhn).
+
+Luhn is a `Python` Package that can validate Credit Card.
+
+# Content
+- [💳 Credit Card Validator](#-credit-card-validator)
+- [Content](#content)
+- [Installation](#installation)
+- [Uses](#uses)
+- [Troubleshooting](#troubleshooting)
+- [Contributing](#contributing)
+- [License](#license)
+
+# Installation
+```bash
+python -m pip install luhn
+```
+
+# Uses
+You can use `validate` function passing credit card number as `string`.
+
+# Troubleshooting
+Create an issue upon your error that is associated with this project.
+
+# Contributing
+Feel free to fork and create pull requests. Your contribution will be appreciated.
+
+# License
+This project is licensed under [BSD License](LICENSE).
\ No newline at end of file