rename. add notes

Signed-off-by: Jeff Carr <[email protected]>

1 files changed, 9 insertions, 0 deletions

diff --git a/readonly.go b/settings.go
index 9d0c1e9..afe5e8a 100644
--- a/readonly.go
+++ b/settings.go
@@ -1,5 +1,14 @@
 package forgepb
 
+/*
+	check settings for a particular gopath
+	this provides checks for:
+
+	IsReadOnly()	// user can't push commits
+	IsPrivate()	// repo can't be published to the pkg.go.dev system
+	DebName()	// for 'zookeeper' returns 'zookeeper-go'
+*/
+
 import (
 	"strings"
 )