diff --git a/README.md b/README.md index 676b96a..39b52be 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ -# Chargily Pay V2 +# Welcome to PHP Package Repository +# for [Chargily Pay](https://chargily.com/business/pay "Chargily Pay")™ Gateway - V2. -PHP Library for [Chargily Pay](https://chargily.com/business/pay "Chargily Pay")™ Gateway - V2. +Thank you for your interest in PHP Package of Chargily Pay™, an open source project by Chargily, a leading fintech company in Algeria specializing in payment solutions and e-commerce facilitating, this Package is providing the easiest and free way to integrate e-payment API through widespread payment methods in Algeria such as EDAHABIA (Algerie Post) and CIB (SATIM) into your PHP/Laravel projects. -The easiest way to integrate e-payment API through EDAHABIA of Algerie Poste and CIB of SATIM into your PHP/Laravel project. +This repository is developed by **[Medboubazine](https://github.com/Medboubazine)** and is open to contributions from developers like you. # Requirements @@ -61,3 +62,43 @@ composer require chargily/chargily-pay # Documentation For frameworks - [Laravel](https://github.com/Chargily/chargily-pay-php/blob/main/docs/frameworks/Laravel.md) + + +## About Chargily Pay™ packages + +Chargily Pay™ packages/plugins are a collection of open source projects published by Chargily to facilitate the integration of our payment gateway into different programming languages and frameworks. Our goal is to empower developers and businesses by providing easy-to-use tools to seamlessly accept payments. + +## API Documentation + +For detailed instructions on how to integrate with our API and utilize Chargily Pay™ in your projects, please refer to our [API Documentation](https://dev.chargily.com/pay-v2/introduction). + +## Developers Community + +Join our developer community on Telegram to connect with fellow developers, ask questions, and stay updated on the latest news and developments related to Chargily Pay™ : [Telegram Community](https://chargi.link/PayTelegramCommunity) + +## How to Contribute + +We welcome contributions of all kinds, whether it's bug fixes, feature enhancements, documentation improvements, or new plugin/package developments. Here's how you can get started: + +1. **Fork the Repository:** Click the "Fork" button in the top-right corner of this page to create your own copy of the repository. + +2. **Clone the Repository:** Clone your forked repository to your local machine using the following command: + +``` +git clone https://github.com/Chargily/chargily-pay-php.git +``` + +3. **Make Changes:** Make your desired changes or additions to the codebase. Be sure to follow our coding standards and guidelines. + +4. **Test Your Changes:** Test your changes thoroughly to ensure they work as expected. + +5. **Submit a Pull Request:** Once you're satisfied with your changes, submit a pull request back to the main repository. Our team will review your contributions and provide feedback if needed. + +## Get in Touch + +Have questions or need assistance? Join our developer community on [Telegram](https://chargi.link/PayTelegramCommunity) and connect with fellow developers and our team. + +We appreciate your interest in contributing to Chargily Pay™! Together, we can build something amazing. + +Happy coding! +