Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gowizzard committed Mar 29, 2021
1 parent 00d4f63 commit 100fc9e
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,24 @@
placetel
# placetel

With this small library you should be able to address some nodes of the Placetel API. Please note that we have only implemented a tiny part of it and will continue to develop it as needed.

Feel free to help us with the development!

## Install

```console
go get github.com/jjideenschmiede/placetel
```

## How to use it?

### SMS

With the SMS sent you are able to send sms through your Placetel account. The whole thing works as follows:

```go
err := placetel.SendSMS("Phone number", "Message", "Token")
if err != nil {
fmt.Println(err)
}
```

0 comments on commit 100fc9e

Please sign in to comment.