From 100fc9eae3bb63676580121631859ad71b4ae2b6 Mon Sep 17 00:00:00 2001
From: Jonas Kwiedor <jonas.kwiedor@jj-ideenschmiede.de>
Date: Mon, 29 Mar 2021 18:56:27 +0200
Subject: [PATCH] Add readme

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8571a7f..01ea686 100644
--- a/README.md
+++ b/README.md
@@ -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)
+}
+```
\ No newline at end of file