Skip to content
This repository has been archived by the owner on Sep 26, 2024. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Add Disclaimer. Improve the usage section.
  • Loading branch information
rahimi-ali authored Aug 24, 2023
1 parent e0672a5 commit 9c43dd4
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@

نظام پایانه‌های فروشگاهی و سامانه مودیان

## Disclaimer
This software is provided as is without any warranty whatsoever, including accuracy and comprehensiveness. We are not associated with Moadian Maliati Organization and we have worked with the API just as simple clients so we are limited in the amount of support and help we can give regarding the functionality of the API. We have however personally used this package and have successfully submitted tens of thousands of invoices.

## Installation

```bash
Expand All @@ -12,6 +15,10 @@ composer require snapp-market-pro/moadian

## Usage

1. Generate a key pair in the admin panel and use the private key as the private key parameter required in `Moadian` class constructor.
2. Get servers public key from the `INFORMATION_SERVER_GET` API endpoint and use it as the public key parameter in `Moadian` class. (see [this issue](https://github.com/Snapp-Market-Pro/moadian/issues/20#issuecomment-1637061790) for sample CURL request)
3. Sample Usage:

```php
<?php

Expand Down

0 comments on commit 9c43dd4

Please sign in to comment.