Browse Source

Updated ToC in read me

Joachim M. Giæver 6 years ago
parent
commit
cd1cba954d
1 changed files with 11 additions and 2 deletions
  1. 11 2
      README.md

+ 11 - 2
README.md

@@ -5,7 +5,16 @@ Go-ini is a package that handles INI-formatted data in your golang-project. The
 
 It also tries to adopt how other «Marshaling»-packages in go are written, so it's simple to override and add functionality for your own code. This also implies that every package that already implements [_TextMarshaling_](https://golang.org/pkg/encoding/#TextMarshaler) and/or [_TextUnmarshaling_](https://golang.org/pkg/encoding/#TextUnmarshaler) (e.g time.Time) is supported.
 # ToC
-- _coming now_
+1. [Installation and update](https://git.giaever.org/joachimmg/go-ini#installation-and-update)
+2. [Usage](https://git.giaever.org/joachimmg/go-ini#usage)
+    1. [Marshal](https://git.giaever.org/joachimmg/go-ini#marshal)
+    2. [Unmarshal](https://git.giaever.org/joachimmg/go-ini#unmarshal)
+    3. [Sectioning](https://git.giaever.org/joachimmg/go-ini#sectioning)
+        * [Example](https://git.giaever.org/joachimmg/go-ini#example)
+    4. [Data-types](https://git.giaever.org/joachimmg/go-ini#data-types)
+        * [Custom types](https://git.giaever.org/joachimmg/go-ini#custom-types)
+            * [Example on how to implement one on your own?](https://git.giaever.org/joachimmg/go-ini#example-on-how-to-implement-one-on-your-own)
+3. [TO-DO](https://git.giaever.org/joachimmg/go-ini#to-do)
 
 # Installation and update:
 ```bash
@@ -121,7 +130,7 @@ type Settings struct { // The parent struct can be named what ever
     }
 }
 ```
-## Special types
+## Data types
 Go-ini will by default ("itself") understand the following types:
 1. Pointers to types of those listed below,
 2. Struct and it's fields of those listed below,