Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
faridfr authored Mar 25, 2021
1 parent 7e12ed9 commit 82e88b7
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

</div>
<hr />

## 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:
Expand All @@ -28,7 +48,7 @@ composer require persian-tools/php-persian-tools
## Usage

``` php
// Usage description here
// soon ...
```

## Testing
Expand Down

0 comments on commit 82e88b7

Please sign in to comment.