Skip to content

Commit

Permalink
doc: create readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mayowa-Ojo committed Oct 30, 2021
1 parent f3f778c commit 2d0a246
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
### Dev-Client-Go
========

dev-api-go is a client library for the Forem (dev.to) [developer api](https://developers.forem.com/api) written in Go. It provides fully typed methods for every operation you can carry out with the current api (beta)(0.9.7)

#### Installation
> Go version >= 1.13
```sh
$ go get github.com/Mayowa-Ojo/dev-client-go
```

#### Usage
Import the package and initialize a new client with your auth token(api-key).
To get a token, see the authentication [docs](https://developers.forem.com/api#section/Authentication)
```go
package main

import (
dev "github.com/Mayowa-Ojo/dev-client-go"
)

func main() {
client, err := dev.NewClient(<your api-key>)
if err != nil {
// handle err
}
}
```

#### Documentation
=========

0 comments on commit 2d0a246

Please sign in to comment.