Skip to content

Commit

Permalink
Merge pull request #11 from sematext/develop
Browse files Browse the repository at this point in the history
Update README.
  • Loading branch information
hollerloudly authored Jul 21, 2020
2 parents e84b7d2 + b73143f commit c275f18
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 13 deletions.
57 changes: 44 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,47 @@
# Sematext Cloud - API Client - Go

This client code talks to [Sematext Cloud API](https://sematext.com/cloud/) providing a way to automate setup of solution monitoring.<br>
It's primary purpose is as a client module supporting [Sematext Terraform Provider](https://github.com/sematext/terraform-provider-sematext)
<br><br>
# <img src="./assets/octi-blue.png" valign="bottom" width="60px"/>**&nbsp;&nbsp;sematext-api-client-go**

Further information and API browsing refer to the [Sematext Cloud API web page](https://sematext.com/docs/api/)
<br>

>*A [Sematext Cloud](https://sematext.com/cloud/) API client, for interaction with Sematext Cloud solution monitoring, alerting and log shipping.*
<br>

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

<br>
One of a family of clients in following flavours:
<br>
<br>

* [sematext-api-client-javascript](https://github.com/sematext/sematext-api-client-javascript "Javascript")
* [sematext-api-client-rust](https://github.com/sematext/sematext-api-client-rust "Rust")
* [sematext-api-client-ruby](https://github.com/sematext/sematext-api-client-ruby "Ruby")
* [sematext-api-client-python](https://github.com/sematext/sematext-api-client-python "Python")
* [sematext-api-client-php](https://github.com/sematext/sematext-api-client-php "PHP")
* [sematext-api-client-java](https://github.com/sematext/sematext-api-client-java "Java")
* [sematext-api-client-go](https://github.com/sematext/sematext-api-client-go "Go/Golang")

<br>
Refer to below link for deeper information on the API itself.
<br>
<br>

* [Sematext Cloud API Reference](https://sematext.com/docs/api/ "API Reference")

<br>

## Contents

- [&nbsp;&nbsp;sematext-api-client-go](#sematext-api-client-go)
- [Contents](#contents)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Authentication](#authentication)
- [Reference](#reference)
- [Documentation for Models](#documentation-for-models)

<br>

## Getting Started

Expand All @@ -16,23 +52,18 @@ These instructions will get you a copy of the project up and running on your loc
* [Go](https://golang.org/) - v1.13.8


### Installing
### Installation

Put the package under your project folder and add the following in import:
```golang
import "./stcloud"
```

### Authentication
## Authentication

This client code requires a Sematext API Access token to function. You can find this by logging into your [Sematext Cloud Account](https://apps.sematext.com/ui/account/api)


### Coding style tests

The code in this repo uses gofmt.


## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
Expand All @@ -51,7 +82,7 @@ This API client was initially generated by the [swagger-codegen](https://github.
- Package version: 1.0.0


## Documentation for API Endpoints
## Reference

All URIs are relative to *https://localhost*

Expand Down
Binary file added assets/octi-blue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c275f18

Please sign in to comment.