v1.0.0

Author: elias-haileselassie

CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.1.0
+
+- test publication
+
+## 1.0.0
+
+- Initial version

README.md

@@ -1,20 +1,22 @@
-# webirr-api-dart-client
 Official Dart Client Library for WeBirr Payment Gateway APIs 
 
-*Requires Dart SDK >=2.12.0 <3.0.0*
+This Client Library provides convenient access to WeBirr Payment Gateway APIs from Dart/Flutter Apps.
 
->This Client Library provides convenient access to WeBirr Payment Gateway APIs from Dart/Flutter Apps.
+*Requires Dart SDK >=2.12.0 <3.0.0*
 
 ## Install
-1. Add the dependecny in pubspec.yaml 
 
->dependencies:
->   webirr: ^0.1.0
+run the following command to install webirr client library
+
+With Dart
 
-2. run the dart pub get command
+```bash
+$ dart pub add webirr
+```
+With Flutter
 
 ```bash
-$ dart pub get
+$ flutter pub add webirr
 ```
 
 ## Usage
@@ -25,7 +27,7 @@ The library needs to be configured with a *merchant Id* & *API key*. You can get
 
 ## Example
 
-# Creating a new Bill / Updating an existing Bill on WeBirr Servers
+### Creating a new Bill / Updating an existing Bill on WeBirr Servers
 
 ```dart
 
@@ -85,7 +87,7 @@ The library needs to be configured with a *merchant Id* & *API key*. You can get
 
 ```
 
-# Getting Payment status of an existing Bill from WeBirr Servers
+### Getting Payment status of an existing Bill from WeBirr Servers
 
 ```dart
 
@@ -120,7 +122,7 @@ The library needs to be configured with a *merchant Id* & *API key*. You can get
 
 ```  
 
-# Deleting an existing Bill from WeBirr Servers (if it is not paid)
+### Deleting an existing Bill from WeBirr Servers (if it is not paid)
 
 ```dart
 
@@ -147,4 +149,4 @@ The library needs to be configured with a *merchant Id* & *API key*. You can get
         'errorCode: ${res.errorCode}'); // can be used to handle specific bussines error such as ERROR_INVLAID_INPUT
   }
 
-```  
+```  

lib/src/bill.dart

@@ -1,3 +1,5 @@
+/// Bill or Invoice object issued to a customer
+/// it is basically a customer name and amount in ETB.
 class Bill {
   String customerCode;
   String customerName;

lib/src/payment.dart

@@ -1,8 +1,9 @@
+/// Payment object returned from getPaymentStatus api call
 class Payment {
   /// 0 = not paid, 1 = payment in progress,  2. paid !
   late int status;
   PaymentDetail? data;
-
+  
   Payment.fromJson(Map<String, dynamic> json) {
     status = json['status'];
     data =
@@ -13,6 +14,7 @@ class Payment {
   bool get isPaid => status == 2;
 }
 
+/// Payment Detail such as Bank Id, Bank Reference Number
 class PaymentDetail {
   late int id;
   late String paymentReference;

pubspec.yaml

@@ -1,11 +1,7 @@
 name: webirr
-version: 0.1.0
-author: WeBirr Team <[email protected]>
+version: 1.0.0
 description: >-
-  Official Dart Client Library for WeBirr APIs
-  This package can be used to integrate your apps with WeBirr payment gateway.
-  It is a wrapper for the REST Web Service API. It can be used to create, update 
-  & delete bills and also check the payment status of bills
+  Official Dart Client Library for WeBirr APIs 
 homepage: https://github.com/webirr/webirr-api-dart-client
 environment:
   sdk: '>=2.12.0 <3.0.0'