Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
unknwon committed Aug 29, 2014
1 parent 7b1e081 commit c0cc0d3
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 73 deletions.
39 changes: 3 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,49 +26,16 @@ The configuration file consists of sections, led by a `[section]` header and fol
go get github.com/Unknwon/goconfig

Or

gopm get github.com/Unknwon/goconfig

## API Documentation

[Go Walker](http://gowalker.org/github.com/Unknwon/goconfig).

## Example(Comments Support!!!!)
## Example

### conf.ini

; Google
google=www.google.com
search=http://%(google)s

; Here are Comments
; Second line
[Demo]
# This symbol can also make this line to be comments
key1=Let's us goconfig!!!
key2=test data
key3=this is based on key2:%(key2)s

[What's this?]
; Not Enough Comments!!
name=try one more value ^-^

[parent]
name=john
relation=father
sex=male
age=32

[parent.child]
age=3

[parent.child.child]

; Auto increment by setting key to "-"
[auto increment]
-=hello
-=go
-=config
Please see [conf.ini](testdata/conf.ini) as an example.

### Usage

Expand Down
37 changes: 2 additions & 35 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,42 +34,9 @@ goconfig [![Build Status](https://drone.io/github.com/Unknwon/goconfig/status.pn

[Go Walker](http://gowalker.org/github.com/Unknwon/goconfig).

## 示例(支持注释!!!!)
## 示例

### conf.ini

; Google
google=www.google.com
search=http://%(google)s

; Here are Comments
; Second line
[Demo]
# This symbol can also make this line to be comments
key1=Let's us goconfig!!!
key2=test data
key3=this is based on key2:%(key2)s

[What's this?]
; Not Enough Comments!!
name=try one more value ^-^

[parent]
name=john
relation=father
sex=male
age=32

[parent.child]
age=3

[parent.child.child]

; Auto increment by setting key to "-"
[auto increment]
-=hello
-=go
-=config
请查看 [conf.ini](testdata/conf.ini) 文件作为使用示例。

### 用例

Expand Down
2 changes: 1 addition & 1 deletion read.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2013 Unknown
// Copyright 2013 Unknwon
//
// Licensed under the Apache License, Version 2.0 (the "License"): you may
// not use this file except in compliance with the License. You may obtain
Expand Down
2 changes: 1 addition & 1 deletion write.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2013 Unknown
// Copyright 2013 Unknwon
//
// Licensed under the Apache License, Version 2.0 (the "License"): you may
// not use this file except in compliance with the License. You may obtain
Expand Down

0 comments on commit c0cc0d3

Please sign in to comment.