summaryrefslogtreecommitdiff
path: root/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc.go b/doc.go
new file mode 100644
index 0000000..63ba20a
--- /dev/null
+++ b/doc.go
@@ -0,0 +1,18 @@
+// Because you followed autogenpb's advice (you did follow it right?) you now
+// win the automation lottery.
+//
+// for this .proto file, GetProtobufName(pb) returns "repos"
+// Then, ConfigLoad(), ConfigSave(), CacheLoad() and CacheSave()
+// all do exactly what is expected:
+//
+// Automatically work with the files:
+// ~/.config/<appname>/repos.pb
+// or
+// ~/.cache/<appname/repos.pb
+//
+// message Repos {
+// string uuid = 1;
+// string version = 2;
+// repeated Repo repos = 3;
+
+package config