Merge pull request #6 from rapidclock/rapidclock-readme-update-1

added go doc and get links
rapidclock · Mar 25, 2019 · 868bab2 · 868bab2
2 parents fbeddc3 + c9ee44a
commit 868bab2
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,14 @@
 # web-octopus
+[![GoDoc](https://godoc.org/github.com/rapidclock/web-octopus/pq?status.svg)](https://godoc.org/github.com/rapidclock/web-octopus)
 [![Build Status](https://travis-ci.com/rapidclock/web-octopus.svg?token=hJhLfHtyz41UyuLTTdFx&branch=master)](https://travis-ci.com/rapidclock/web-octopus)
 <br>
 A concurent web crawler written in Go.
 
+## Install
+
+	go get github.com/rapidclock/web-octopus/octopus
+	go get github.com/rapidclock/web-octopus/adapter
+
 ## Current Features:
 - Depth Limited Crawling
 - User specified valid protocols