Merge pull request #16 from tiendc/update-docs

Update guideline

Author: tiendc

README.md

@@ -1,9 +1,11 @@
 [![Go Version][gover-img]][gover] [![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] [![GoReport][rpt-img]][rpt]
 
-# High level CSV lib for Go 1.18+
+# High level CSV library for Go 1.18+
 
 This is a library for decoding and encoding CSV at high level as it provides convenient methods and many configuration options to process the data the way you expect.
 
+This library is inspired by the project https://github.com/jszwec/csvutil.
+
 ## Functionalities
 
 **Decoding**

docs/DECODING.md

@@ -10,6 +10,7 @@
 - [Dynamic inline columns](#dynamic-inline-columns)
 - [Custom unmarshaler](#custom-unmarshaler)
 - [Custom column delimiter](#custom-column-delimiter)
+- [Decode one-by-one](#decode-one-by-one)
 - [Header localization](#header-localization)
 - [Render error as human-readable format](#render-error-as-human-readable-format)
 
@@ -358,6 +359,35 @@ tom,1989-11-11`)
     // {Name:tom Age:9 Address:new york}
 ```
 
+### Decode one-by-one
+
+```go
+    data := []byte(`
+name,age,address
+jerry,20,
+tom,26,new york`)
+
+    type Student struct {
+        Name    string `csv:"name"`
+        Age     int    `csv:"age"`
+        Address string `csv:"address"`
+    }
+
+    reader := csv.NewReader(bytes.NewReader(data))
+    decoder := csvlib.NewDecoder(reader)
+    var student Student
+    for decoder.DecodeOne(&student) != csvlib.ErrFinished {
+        fmt.Printf("%+v\n", student)
+    }
+    
+    fmt.Printf("%+v\n", *decoder.Finish())
+    
+    // Output:
+    // {Name:jerry Age:20 Address:}
+    // {Name:tom Age:26 Address:new york}
+    // {totalRow:3 unrecognizedColumns:[] missingOptionalColumns:[]}
+```
+
 ### Header localization
 
 - This functionality allows to decode multiple input data with header translated into specific language

docs/ENCODING.md

@@ -9,6 +9,7 @@
 - [Dynamic inline columns](#dynamic-inline-columns)
 - [Custom marshaler](#custom-marshaler)
 - [Custom column delimiter](#custom-column-delimiter)
+- [Encode one-by-one](#encode-one-by-one)
 - [Header localization](#header-localization)
 
 ## Content
@@ -255,6 +256,39 @@ func (d BirthDate) MarshalCSV() ([]byte, error) {
     // tom	19	new york
 ```
 
+### Encode one-by-one
+
+```go
+    type Student struct {
+        Name    string `csv:"name"`
+        Age     int    `csv:"age"`
+        Address string `csv:"address"`
+    }
+
+    students := []Student{
+        {Name: "jerry", Age: 20, Address: "tokyo"},
+        {Name: "tom", Age: 19, Address: "new york"},
+    }
+    var buf bytes.Buffer
+    writer := csv.NewWriter(&buf)
+    encoder := csvlib.NewEncoder(writer)
+
+    for _, student := range students {
+        if err := encoder.EncodeOne(student); err != nil {
+            fmt.Println("error:", err)
+            break
+        }
+    }
+    encoder.Finish()
+    writer.Flush()
+    fmt.Println(buf.String())
+
+    // Output:
+    // name,age,address
+    // jerry,20,tokyo
+    // tom,19,new york
+```
+
 ### Header localization
 
 - This functionality allows to encode CSV data with header translated into a specific language.