vendor deps and add build docs

tedwardd · Sep 14, 2017 · 6a815d5 · 6a815d5
1 parent 1dd7b1b
commit 6a815d5
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 webby
+vendor/
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/Gopkg.toml b/Gopkg.toml
@@ -0,0 +1,30 @@
+
+# Gopkg.toml example
+#
+# Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md
+# for detailed Gopkg.toml documentation.
+#
+# required = ["github.com/user/thing/cmd/thing"]
+# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
+#
+# [[constraint]]
+#   name = "github.com/user/project"
+#   version = "1.0.0"
+#
+# [[constraint]]
+#   name = "github.com/user/project2"
+#   branch = "dev"
+#   source = "github.com/myfork/project2"
+#
+# [[override]]
+#  name = "github.com/x/y"
+#  version = "2.4.0"
+
+
+[[constraint]]
+  branch = "master"
+  name = "github.com/clarkf/libirc"
+
+[[constraint]]
+  branch = "master"
+  name = "golang.org/x/net"
diff --git a/README.md b/README.md
@@ -1,3 +1,16 @@
 # Webby Bot
 Webby is an IRC bot written in Go. The initial goal is to provide helpers for
 parsing URLs to provide the URL title and a shortend URL.
+
+# Building
+
+Building requires go dep:
+`$ go get -u github.com/golang/dep/cmd/dep`
+
+
+```
+$ git clone git@github.com:k4k/webby-bot.git
+$ cd webby-bot
+$ dep ensure
+$ go build
+```