summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRi Xu <xuri.me@gmail.com>2016-08-30 12:27:35 +0800
committerRi Xu <xuri.me@gmail.com>2016-08-30 12:27:35 +0800
commit2125f5f7a8ff1647ad47663613860995c55be3b6 (patch)
treeeacd7343e22e5eb1a40f80b397765edfbc2f6bb4 /README.md
parenta9d3ee28693adfe920b3cd047f52862d8a79a00e (diff)
Update readme and Travis CI added.
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 13 insertions, 14 deletions
diff --git a/README.md b/README.md
index e9fd91b..d75bf1a 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 <https://opensource.org/licenses/BSD-3-Clause>. \ 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