EC-21: FEAT: Added new Go package and initialized the repo #1
38
README.md
38
README.md
@@ -1,22 +1,26 @@
|
||||
# 📦 Repository Name
|
||||
# 📦 Evercatch Go
|
||||
|
||||
> Short one-line description of what this repository does.
|
||||
> Official Go SDK for Evercatch webhook infrastructure platform.
|
||||
|
||||
---
|
||||
|
||||
## 🧭 Overview
|
||||
|
||||
Describe what this service/module is responsible for within the Evercatch platform.
|
||||
This repository contains the official Go SDK for the Evercatch platform. Its purpose is to provide a simple and convenient interface for developers to interact with the Evercatch API, manage webhooks, and handle events within their Go applications.
|
||||
|
||||
**⚠️ This SDK is currently under active development and is not yet ready for production use. The package published on npm is a placeholder to reserve the name.**
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Tech Stack
|
||||
|
||||
The final technology stack is being determined. The planned stack is as follows:
|
||||
|
||||
| Layer | Technology |
|
||||
| :--- | :--- |
|
||||
| Language | — |
|
||||
| Framework | — |
|
||||
| Key Dependencies | — |
|
||||
| Language | Go |
|
||||
| Framework | None (Standard Library + Minimal Dependencies) |
|
||||
| Key Dependencies | `net/http` (for HTTP), `encoding/json` (for JSON handling) |
|
||||
|
||||
---
|
||||
|
||||
@@ -24,21 +28,27 @@ Describe what this service/module is responsible for within the Evercatch platfo
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Docker & Docker Compose
|
||||
- Node.js / Python (specify version)
|
||||
- Go 1.21+
|
||||
|
||||
### Installation (Future)
|
||||
|
||||
Once released, the package will be available on Go:
|
||||
```bash
|
||||
# This will not work until the first official release
|
||||
go get git.psmattas.com/evercatch/evercatch-go
|
||||
```
|
||||
|
||||
### Local Development
|
||||
|
||||
The repository can be cloned for contribution or testing once development is further along.
|
||||
|
||||
```bash
|
||||
# Clone the repo
|
||||
git clone https://git.psmattas.com/Evercatch/REPO_NAME.git
|
||||
cd REPO_NAME
|
||||
git clone https://git.psmattas.com/Evercatch/evercatch-go.git
|
||||
|
||||
# Copy environment variables
|
||||
cp .env.example .env
|
||||
cd evercatch-go
|
||||
|
||||
# Start services
|
||||
docker compose up -d
|
||||
# Note: The project is not yet functional.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
6
client.go
Normal file
6
client.go
Normal file
@@ -0,0 +1,6 @@
|
||||
package evercatch
|
||||
|
||||
// Coming Soon
|
||||
// Official Go SDK for Evercatch webhook platform
|
||||
// Expected launch: Q2 2026
|
||||
// Visit https://evercatch.dev
|
||||
Reference in New Issue
Block a user