Add bots documentation

bots/bots.go

@@ -1,3 +1,6 @@
+// This package helps the backend determine which clients are bots or crawlers.
+// In Write.as, this is used to prevent certain things when viewing posts, like
+// incrementing the view count.
 package bots
 
 var bots = map[string]bool{
@@ -26,6 +29,8 @@ var bots = map[string]bool{
 	"Twitterbot/1.0":  true,
 }
 
+// IsBot returns whether or not the provided User-Agent string is a known bot
+// or crawler.
 func IsBot(ua string) bool {
 	if _, ok := bots[ua]; ok {
 		return true

bots/findBots.sh

@@ -9,6 +9,9 @@ cat /var/log/$1 | grep -i bot | awk -F\" '{print $4}' | sort | uniq > bots.txt
 rm bots.go
 
 cat > bots.go << EOM
+// This package helps the backend determine which clients are bots or crawlers.
+// In Write.as, this is used to prevent certain things when viewing posts, like
+// incrementing the view count.
 package bots
 
 var bots = map[string]bool {
@@ -23,6 +26,8 @@ done <bots.txt
 cat >> bots.go << EOM
 };
 
+// IsBot returns whether or not the provided User-Agent string is a known bot
+// or crawler.
 func IsBot(ua string) bool {
     if _, ok := bots[ua]; ok {
         return true