Skip to content

Commit

Permalink
πŸ“ƒ docs: create readme for uses
Browse files Browse the repository at this point in the history
  • Loading branch information
kylesinlynn committed Jan 23, 2023
1 parent 8854b71 commit a8fbf09
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit a8fbf09

Please sign in to comment.