diff --git a/README.md b/README.md index c73d4bd..9a9ac31 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ -# epay-gateway-nodejs (beta version) -Chargily ePay Gateway (Js Package) +# Chargily ePay Gateway Js + +![Chargily ePay Gateway](https://raw.githubusercontent.com/Chargily/epay-gateway-php/main/assets/banner-1544x500.png "Chargily ePay Gateway") + +Integrate ePayment gateway with Chargily easily. +- Currently support payment by **CIB / EDAHABIA** cards and soon by **Visa / Mastercard** +- This is a **Js package**, If you are using another programing language [Browse here](https://github.com/Chargily/) or look to [API documentation](https://github.com/Chargily/epay-gateway-php/blob/master/README_API.md) + +# Requirements +1. Js 2018 or later. +2. Get your API Key/Secret from [ePay by Chargily](https://epay.chargily.com.dz) dashboard for free + +# Installation +1. Via npm (Recomended) +```bash +npm i chargily-epay-gateway +``` +2. Download as ZIP +We do not recommend this option. But be careful to download the updated versions every a while [Download](https://github.com/Chargily/epay-gateway-nodejs/releases/)