diff --git a/README.md b/README.md index abb2ab2..d40d660 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,34 @@ [![Latest Stable Version](https://poser.pugx.org/persian-tools/php-persian-tools/v/stable)](https://packagist.org/packages/persian-tools/php-persian-tools) [![Total Downloads](https://poser.pugx.org/persian-tools/php-persian-tools/downloads)](https://packagist.org/packages/persian-tools/php-persian-tools) [![Build Status](https://github.com/persian-tools/php-persian-tools/workflows/Continuous%20Integration/badge.svg)](https://github.com/persian-tools/php-persian-tools/actions) -[![CodeFactor](https://www.codefactor.io/repository/github/persian-tools/php-persian-tools/badge)](https://www.codefactor.io/repository/github/persian-tools/php-persian-tools) [![Code Style](https://github.styleci.io/repos/214197383/shield?style=flat)](https://github.styleci.io/repos/214197383) [![Code Coverage](https://codecov.io/gh/persian-tools/php-persian-tools/branch/master/graph/badge.svg?sanitize=true)](https://codecov.io/gh/persian-tools/php-persian-tools) [![License](https://poser.pugx.org/persian-tools/php-persian-tools/license)](https://packagist.org/packages/persian-tools/php-persian-tools) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-orange.svg)](https://github.com/persian-tools/php-persian-tools) +![status](https://img.shields.io/badge/under_development-lightblue.svg) +
+## Features + +- [x] [Adding ordinal suffixes] +- [x] Converting Persian words to number +- [x] Converting Persian numbers to word +- [x] Adding and removing separator to/from numbers +- [ ] [Converting Persian numbers to Arabic / English numbers and reverse] +- [ ] [Checking a string has/is Persian] +- [x] [Validating Iranians national id] +- [ ] Finding city and province names by national id +- [ ] [Calculating bills] +- [ ] Checking IBAN of the bank account (_SHEBA_) +- [x] [Validating ATM card number] +- [x] Finding name of banks by ATM card number +- [ ] Getting information from vehicle plate +- [x] [Fixing and decoding URLs with whitespace] + + + ## Getting started You can install the package via composer: @@ -28,7 +48,7 @@ composer require persian-tools/php-persian-tools ## Usage ``` php -// Usage description here +// soon ... ``` ## Testing