-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f3f778c
commit 2d0a246
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
========= |