.drone.yml

@@ -0,0 +1,16 @@
+kind: pipeline
+type: docker
+name: Tests
+
+steps:
+- name: test
+  image: golang
+  commands:
+  - cd tracker
+  - make build
+  - make test
+
+trigger:
+  event:
+    - push
+    - tag

.gitignore

@@ -15,6 +15,9 @@
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 
+# build directory
+tracker/build
+
 # Dependency directories (remove the comment below to include it)
 # vendor/
 

README.md

@@ -1,3 +1,29 @@
-# public-ip-tracker
+# Public IP tracker
 
-Simple Go project to track current public IP and notify changes to a telegram bot
+[![Build Status](https://drone.faercol.me/api/badges/faercol/public-ip-tracker/status.svg)](https://drone.faercol.me/faercol/public-ip-tracker)
+
+
+Telegram bot that detects changes to the device's public IP. This is particularily useful when
+the device is handled by an ISP that does not provide a static public IP, such as a home device.
+
+## Features
+
+### Automatic public IP detection and monitoring
+
+Upon startup, the current public IP is detected, and a status message is sent to a specific Telegram
+channel with the relevant information.
+
+> Insert example message here
+
+When running as a daemon, the program automatically monitors the current public IP adress for changes.
+If the IP changes for some reason, then the new updated adress is sent to the specific Telegram
+channel.
+
+> Insert example message here
+
+### On-demand public IP
+
+The relevant channel is monitored during the program execution. This allows the user to send a
+command to the bot in order to get the current public IP on-demand.
+
+> Insert example here

tracker/Makefile

@@ -0,0 +1,7 @@
+.PHONY: build test
+
+build:
+	go build -o build/
+
+test:
+	go test -v ./...

tracker/go.mod

@@ -0,0 +1,3 @@
+module git.faercol.me/faercol/public-ip-tracker/tracker
+
+go 1.16

tracker/main.go

@@ -0,0 +1,11 @@
+package main
+
+import "fmt"
+
+func testMethod(a int) int {
+	return a + 2
+}
+
+func main() {
+	fmt.Println("public ip tracker")
+}

tracker/main_test.go

@@ -0,0 +1,9 @@
+package main
+
+import "testing"
+
+func TestTestMethod(t *testing.T) {
+	if testMethod(12) != 14 {
+		t.Fatalf("Unexpected result %d", testMethod((12)))
+	}
+}