From 2125f5f7a8ff1647ad47663613860995c55be3b6 Mon Sep 17 00:00:00 2001 From: Ri Xu Date: Tue, 30 Aug 2016 12:27:35 +0800 Subject: [PATCH] Update readme and Travis CI added. --- .travis.yaml | 17 +++++++++++++++++ README.md | 27 +++++++++++++-------------- 2 files changed, 30 insertions(+), 14 deletions(-) create mode 100644 .travis.yaml diff --git a/.travis.yaml b/.travis.yaml new file mode 100644 index 00000000..d9f3ffd2 --- /dev/null +++ b/.travis.yaml @@ -0,0 +1,17 @@ +language: go + +install: + - go get -d -t -v ./... && go build -v ./... + +go: + - 1.5 + - 1.6 + - 1.7 + - tip + +script: + - go vet ./... + - go test -v -coverprofile=coverage.txt -covermode=atomic + +after_success: + - bash <(curl -s https://codecov.io/bash) \ No newline at end of file diff --git a/README.md b/README.md index e9fd91b2..d75bf1a9 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,20 @@ -* Excelize - ![Excelize](./excelize.png "Excelize") -** Introduction -Excelize is a library written in pure Golang and providing a set of function that allow you to write to and read from XLSX files. +# Excelize +## Introduction +Excelize is a library written in pure Golang and providing a set of function that allow you to write to and read from XLSX files. The full API docs can be viewed using go’s built in documentation tool, or online at [godoc.org](https://godoc.org/github.com/Luxurioust/excelize). -** Basic Usage +## Basic Usage -*** Installation +### Installation ``` -go get github.com/luxurioust/excelize +go get github.com/Luxurioust/excelize ``` -*** Create XLSX files +### Create XLSX files Here is a minimal example usage that will create XLSX file. @@ -24,7 +23,7 @@ package main import ( "fmt" - "github.com/luxurioust/excelize" + "github.com/Luxurioust/excelize" ) func main() { @@ -40,7 +39,7 @@ func main() { } ``` -*** Writing XLSX files +### Writing XLSX files The following constitutes the bare minimum required to write an XLSX document. @@ -49,7 +48,7 @@ package main import ( "fmt" - "github.com/luxurioust/excelize" + "github.com/Luxurioust/excelize" ) func main() { @@ -70,10 +69,10 @@ func main() { } ``` -** Contributing +## Contributing Contributions are welcome! Open a pull request to fix a bug, or open an issue to discuss a new feature or change. -** Licenses +## Licenses -This program is under the terms of the BSD 3-Clause License. See . \ No newline at end of file +This program is under the terms of the BSD 3-Clause License. See [https://opensource.org/licenses/BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause). \ No newline at end of file