Added readme

LeakIX · Jul 15, 2020 · ccfc0cc · ccfc0cc
1 parent 0578f68
commit ccfc0cc
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,29 @@
+# LeakIXClient
+
+This is a Go library making queries to LeakIX easier.
+
+
+## Usage
+
+```golang
+package main
+import (
+	"fmt"
+	"gitlab.nobody.run/tbi/LeakIXClient"
+)
+
+func main(){
+	// Create a searcher
+	LeakIXSearch := LeakIXClient.SearchResultsClient{
+		Scope: "leak",
+		Query: "protocol:kafka AND \"telecom_italia_data\"",
+	}
+	// Iterate, the lib will query further pages if needed
+	for LeakIXSearch.Next() {
+		// Use the result
+		leak := LeakIXSearch.SearchResult()
+		fmt.Printf("%s:%s - Country:%s\n", leak.Ip, leak.Port, leak.GeoLocation.CountryName)
+	}
+}
+
+```
diff --git a/example/main.go b/example/main.go
@@ -0,0 +1,19 @@
+package main
+import (
+	"fmt"
+	"gitlab.nobody.run/tbi/LeakIXClient"
+)
+
+func main(){
+	// Create a searcher
+	LeakIXSearch := LeakIXClient.SearchResultsClient{
+		Scope: "leak",
+		Query: "protocol:kafka AND \"telecom_italia_data\"",
+	}
+	// Iterate, the lib will query further pages if needed
+	for LeakIXSearch.Next() {
+		// Use the result
+		leak := LeakIXSearch.SearchResult()
+		fmt.Printf("%s:%s - Country:%s\n", leak.Ip, leak.Port, leak.GeoLocation.CountryName)
+	}
+}