Update docs.

toomore · Apr 14, 2015 · ce1ba3f · ce1ba3f
1 parent cfc9e33
commit ce1ba3f
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
 gogrs
 ======
 
-[![GoDoc](https://godoc.org/github.com/toomore/gogrs?status.svg)](https://godoc.org/github.com/toomore/gogrs)
-[![Build Status](https://travis-ci.org/toomore/gogrs.svg?branch=master)](https://travis-ci.org/toomore/gogrs)
-[![Coverage Status](https://coveralls.io/repos/toomore/gogrs/badge.svg?branch=master)](https://coveralls.io/r/toomore/gogrs?branch=master)
+[![GoDoc](https://godoc.org/github.com/toomore/gogrs?status.svg)](https://godoc.org/github.com/toomore/gogrs) [![Build Status](https://travis-ci.org/toomore/gogrs.svg?branch=master)](https://travis-ci.org/toomore/gogrs) [![Coverage Status](https://coveralls.io/repos/toomore/gogrs/badge.svg?branch=master)](https://coveralls.io/r/toomore/gogrs?branch=master)
+
+gogrs now is still in development. I will try my best to speed up to completed the same function with [grs](https://github.com/toomore/grs) (Python). gogrs 是擷取台灣上市股票股價資訊工具，目前還在大量的開發中。原始工具是用 [grs](https://github.com/toomore/grs)（Python 套件），目標是將基本功能用 go 來實作。
 
 Packages
 ---------
 
-1. realtime - [擷取盤中即時股價資訊](https://godoc.org/github.com/toomore/gogrs/realtime)
-2. twse - [擷取上市股票股價資訊](https://godoc.org/github.com/toomore/gogrs/twse)
+1. realtime - [擷取盤中個股、指數即時股價資訊](https://godoc.org/github.com/toomore/gogrs/realtime)
+2. twse - [擷取台灣股市上市、上櫃股票資訊](https://godoc.org/github.com/toomore/gogrs/twse)
 3. utils - [套件所需的公用工具](https://godoc.org/github.com/toomore/gogrs/utils)
diff --git a/doc.go b/doc.go
@@ -6,15 +6,15 @@ gogrs 是擷取台灣上市股票股價資訊工具，目前還在大量的開
 
 Paceage realtime
 
-擷取盤中即時股價資訊
+擷取盤中個股、指數即時股價資訊
 
 Package twse
 
-擷取上市股票股價資訊
+擷取台灣股市上市、上櫃股票資訊
 
 Package utils
 
-一些公用程式
+套件所需的公用工具
 
 */
 package gogrs
diff --git a/realtime/realtime_stock.go b/realtime/realtime_stock.go
@@ -1,5 +1,5 @@
 // Package realtime - Fetch realtime stock data info http://mis.tse.com.tw/
-// 擷取盤中即時股價資訊
+// 擷取盤中個股、指數即時股價資訊
 //
 package realtime
 

diff --git a/twse/stock_daily_data.go b/twse/stock_daily_data.go
@@ -1,5 +1,5 @@
-// Package twse - Fetch stock data from http://www.twse.com.tw/
-// 擷取台灣股市上市股票資訊
+// Package twse - Fetch stock data from TWSE, OTC
+// 擷取台灣股市上市、上櫃股票資訊
 //
 package twse
 

diff --git a/utils/utils.go b/utils/utils.go
@@ -1,4 +1,5 @@
-// Package utils - some utils.
+// Package utils - 套件所需的公用工具
+//
 package utils
 
 import (