basics

DOCS.md

@@ -0,0 +1,29 @@
+# Onramp I2P and Tor Library
+
+[![GoDoc](https://img.shields.io/badge/pkg.go.dev-doc-blue)](http://pkg.go.dev/.)
+[![Go Report Card](https://goreportcard.com/badge/.)](https://goreportcard.com/report/.)
+
+## Variables
+
+I2P_KEYSTORE_PATH is the place where I2P Keys will be saved.
+it defaults to the directory "i2pkeys" current working directory
+reference it by calling I2PKeystorePath() to check for errors
+
+```golang
+var I2P_KEYSTORE_PATH = i2pdefault
+```
+
+ONION_KEYSTORE_PATH is the place where Onion Keys will be saved.
+it defaults to the directory "onionkeys" current working directory
+reference it by calling OnionKeystorePath() to check for errors
+
+```golang
+var ONION_KEYSTORE_PATH = tordefault
+```
+
+```golang
+var OPT_DEFAULTS = sam3.Options_Default
+```
+
+---
+Readme created from Go doc with [goreadme](https://github.com/posener/goreadme)

gen.go

@@ -0,0 +1,31 @@
+//go:build gen
+// +build gen
+
+package main
+
+import (
+	"log"
+	"os"
+	"os/exec"
+)
+
+func main() {
+	cmd := exec.Command("goreadme", "-badge-godoc", "-badge-goreportcard", "-title", "Onramp I2P and Tor Library", "-factories", "-methods", "-variabless")
+	file, err := os.Create("DOCS.md")
+	if err != nil {
+		log.Fatal(err)
+	}
+	cmd.Stdout = file
+	cmd.Stderr = os.Stderr
+	err = cmd.Run()
+	if err != nil {
+		log.Fatal(err)
+	}
+	cmdEdgar := exec.Command("edgar")
+	cmdEdgar.Stdout = os.Stdout
+	cmdEdgar.Stderr = os.Stderr
+	err = cmdEdgar.Run()
+	if err != nil {
+		log.Fatal(err)
+	}
+}