add license, add more to readme

Author: ahmedshaaban

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Ahmed Shaaban
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -6,4 +6,159 @@
 
 ## Description
 
-fawry-go is a Go package interfacing with Fawry's payment gateway API 
+fawry-go is a Go package interfacing with Fawry's payment gateway API. this package is inspired by Amr Bakry's ruby [gem](https://github.com/fawry-api/fawry "fawry-ruby§")
+
+_**`important note`**_: You need to have a contract with fawry to use their service.
+
+## Requirements
+
+Go 1.8 or above.
+
+## Getting Started
+
+### Installation
+
+Run the following command to install the package:
+```
+go get github.com/ahmedshaaban/fawry-go
+```
+
+### Charge Request
+
+```go
+package main
+
+import (
+	"fmt"
+    "io/ioutil"
+
+	"github.com/ahmedshaaban/fawry-go"
+)
+
+func main() {
+	fc := fawry.Client{
+		IsSandbox:      true,
+		FawrySecureKey: "SecuredKeyProvidedByFawry",
+	}
+
+	charge := fawry.Charge{
+		MerchantCode:      "is0N+YQzlE4=",
+		MerchantRefNum:    "9990064204",
+		CustomerProfileID: "9990064204",
+		CustomerMobile:    "01000000200",
+		CustomerEmail:     "77@test.com",
+		PaymentMethod:     "PAYATFAWRY",
+		Amount:            "20.10",
+		CurrencyCode:      "EGP",
+		Description:       "the charge request description",
+		PaymentExpiry:     1516554874077,
+		ChargeItems: []fawry.ChargeItem{
+			fawry.ChargeItem{
+				ItemID:      "897fa8e81be26df25db592e81c31c",
+				Description: "lorem",
+				Price:       "15.20",
+				Quantity:    1,
+			},
+		},
+    }
+    
+    resp, err := fc.ChargeRequest(charge)
+	if err != nil {
+		fmt.Println(err)
+		return
+    }
+
+    defer resp.Body.Close()
+
+	fmt.Println("response Status:", resp.Status)
+	fmt.Println("response Headers:", resp.Header)
+	body, _ := ioutil.ReadAll(resp.Body)
+    fmt.Println("response Body:", string(body))
+}
+    
+```
+
+### Refund Request
+
+```go
+package main
+
+import (
+	"fmt"
+    "io/ioutil"
+
+	"github.com/ahmedshaaban/fawry-go"
+)
+
+func main() {
+	fc := fawry.Client{
+		IsSandbox:      true,
+		FawrySecureKey: "SecuredKeyProvidedByFawry",
+	}
+
+	refund := fawry.Refund{
+		MerchantCode:    "1013969",
+		ReferenceNumber: "322818",
+		RefundAmount:    "100.00",
+		Reason:          "Bad Quality ",
+	}
+
+    resp, err := fc.RefundRequest(refund)
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+    defer resp.Body.Close()
+
+	fmt.Println("response Status:", resp.Status)
+	fmt.Println("response Headers:", resp.Header)
+	body, _ := ioutil.ReadAll(resp.Body)
+    fmt.Println("response Body:", string(body))
+}
+    
+```
+
+### Status Request
+
+```go
+package main
+
+import (
+	"fmt"
+    "io/ioutil"
+
+	"github.com/ahmedshaaban/fawry-go"
+)
+
+func main() {
+	fc := fawry.Client{
+		IsSandbox:      true,
+		FawrySecureKey: "SecuredKeyProvidedByFawry",
+	}
+
+	status := fawry.Status{
+		MerchantCode:   "is0N+YQzlE4=",
+		MerchantRefNum: "99900642041",
+	}
+
+    resp, err := fc.StatusRequest(refund)
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
+    defer resp.Body.Close()
+
+	fmt.Println("response Status:", resp.Status)
+	fmt.Println("response Headers:", resp.Header)
+	body, _ := ioutil.ReadAll(resp.Body)
+    fmt.Println("response Body:", string(body))
+}
+    
+```
+
+## TODO:
+- Read configuration keys (merchant code, secure key) from env vars
+- Add public API documentation to README
+- Increase code coverage