EmeraldLS / mono-go

Optimize Mono.co client library for Golang

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MonoGo

Go Reference Go Report Card

  • Still undergoing development, not ready for use.

DiscordGo logo

MonoGo is a Go package that provides low level bindings to the Mono client API. MonoGo has nearly complete support for all of the Mono API endpoints.

For more info related to this package, visit the official Mono documentation.

Getting Started

Installing

This assumes you already have a working Go environment, if not please see this page first.

go get will always pull the latest tagged release from the master branch.

go get github.com/emeraldls/monogo

Usage

Import the package into your project.

import "github.com/emeraldls/monogo"

Construct a new Mono client which can be used to access the variety of Mono API endpoints.

mono := monogo.New("secret key")

See Documentation and Examples below for more detailed information.

Documentation

NOTICE: This library and the Mono API are unfinished. Because of that there may be major changes to library in the future.

The MonoGo code is fairly well documented at this point and is currently the only documentation available. Go reference (below) presents that information in a nice format.

  • Go Reference
  • Hand crafted documentation coming eventually.

Examples

Troubleshooting

Contributing

Contributions are very welcomed, however please follow the below guidelines.

  • First open an issue describing the bug or enhancement so it can be discussed.
  • Try to match current naming conventions as closely as possible.
  • This package is intended to be a low level direct mapping of the Mono API, so please avoid adding enhancements outside of that scope without first discussing it.
  • Create a Pull Request with your changes against the master branch.

About

Optimize Mono.co client library for Golang

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Go 100.0%