adding README.md initial content

README.md

@@ -1,8 +1,97 @@
-# reamaze-go: go client for 
+# reamaze-go: Re:amaze Golang API Client
 
 ![testing](https://github.com/panperla/reamaze-go/actions/workflows/tests.yml/badge.svg)
 [![codecov](https://codecov.io/gh/panperla/reamaze-go/graph/badge.svg?token=R6888TMAL6)](https://codecov.io/gh/panperla/reamaze-go)
 [![License](https://img.shields.io/github/license/panperla/reamaze-go)](https://github.com/panperla/reamaze-go/blob/main/LICENSE)
 [![godoc](https://godoc.org/github.com/panperla/reamaze-go?status.svg)](https://pkg.go.dev/github.com/panperla/[email protected]/reamaze)
 
+## Overview
 
+This repository houses a Golang package designed to serve as a client for interacting with the Re:amaze REST API. Re:amaze, a platform renowned for its customer support and engagement capabilities, exposes a robust API that this client encapsulates and simplifies for seamless integration into Golang applications.
+
+## Endpoint Coverage
+
+**reamaze-go** covers all [https://www.reamaze.com/api](https://www.reamaze.com/api) REST API methods:
+
+- **ARTICLES:** Retrieving Articles, Get Article, Creating Articles, Updating Articles
+- **CHANNELS:** Retrieving Channels, Retrieving Channels
+- **CONTACTS:** Retrieving Contacts, Create Contacts, Update Contacts, Get Contact Identities, Create Identities
+- **CONTACT NOTES:** Retrieving Notes, Create Note, Update a note, Delete a note
+- **CONVERSATIONS:** Retrieving Conversations, Get Conversation, Creating Conversations, Updating Conversations
+- **MESSAGES:** Retrieving Messages, Creating Messages
+- **REPORTS:** Volume, Response Time, Staff, Tags, Channel Summary
+- **RESPONSE TEMPLATES:** Retrieving Response Templates, Get Response Templates, Creating Response Templates, Updating Response Templates
+- **STAFF:** Retrieving Staff, Create Staff User
+- **STATUS PAGE:** Retrieving Incidents, Get Incident, Create Incident, Update Incident, Retrieving Systems
+
+## Getting Started
+
+### Prerequisites
+Before getting started, ensure you have the following:
+
+- Re:amaze Account: You need a Re:amaze account with a valid email address.
+
+- API Token: Generate an API token from your Re:amaze account settings. This token will be used for authentication when making API requests.
+
+- Re:amaze Brand: Associate your Re:amaze account with the relevant brand. The brand serves as a context for API operations, and you must specify it when initializing the client.
+
+### Installation
+
+To incorporate the Re:amaze Golang API client into your project, use the following `go get` command:
+
+```bash
+go get -u github.com/panperla/reamaze-go/reamaze
+```
+
+## Example Usage
+
+### Retrieving Articles
+```go
+package main
+
+import (
+ "fmt"
+ "github.com/panperla/reamaze-go/reamaze"
+)
+
+
+func main() {
+ // Replace these values with your Re:amaze credentials
+ email := "[email protected]"
+ apiToken := "your-api-token"
+ brand := "your-brand"
+
+ // Initialize Re:amaze client
+ reamazeClient, err := reamaze.NewClient(email, apiToken, brand)
+ if err != nil {
+ log.Println(err)
+ }
+
+ // Example: Get a list of articles
+ articles, err := reamazeClient.GetArticles()
+ if err != nil {
+ fmt.Println("Error:", err)
+ return
+ }
+
+ // Process the list of articles as needed
+ fmt.Println("Articles:", articles)
+}
+```
+
+Refer to the documentation for detailed information on each endpoint and usage examples.
+Also please see [godoc](https://pkg.go.dev/github.com/panperla/[email protected]/reamaze) for all availanle methods. 
+
+## Contribution Guidelines
+
+We welcome contributions, bug reports, and feature requests. Fork and make a Pull Request, or create an Issue if you see any problem.
+
+## Sponsorship
+
+The development of this package was sponsored by [Meant4.com Software House](https://meant4.com/?utm_source=github_reamaze).
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
+Thank you for considering and contributing to the Re:amaze Golang API client. We look forward to your involvement in enhancing its functionality and reliability.