Skip to content

Commit

Permalink
Update readme terminology
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmedalhulaibi authored Dec 1, 2020
1 parent ae2d305 commit ee3c85f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@



The purpose of this package is provide a utility to read a record from a structured [flat-file database](https://en.wikipedia.org/wiki/Flat-file_database) or a record from a text file into a struct. The intent is to eliminate boilerplate code for reading data from a flat file and mapping it to the fields in a struct.
This package provides a utility to read a fixed-width record from a [flat-file database](https://en.wikipedia.org/wiki/Flat-file_database) or a text file. The intent is to eliminate boilerplate code for reading data from a flat file and mapping it to the fields in a struct.

This library allows you to define your record layout mapping using struct tags.
This package allows you to define your record layout mapping using struct tags.

This library provides a method `Unmarshal` which will convert a record (slice of bytes) into a struct.
This packge provides a method `Unmarshal` which will convert a record (slice of bytes) into a struct.

# Usage

Expand All @@ -20,7 +20,7 @@ Use your favourite dependency tool to pull the code. dep, go mod, etc.

## Examples

Please refer to [examples](https://github.com/ahmedalhulaibi/flatfile/tree/master/example) folder in repo for all examples.
Please refer to the [examples](https://github.com/ahmedalhulaibi/flatfile/tree/master/example) folder in repo for all examples.

Let's say I have a text file `customers.txt` which contains customer data. There are 2 records:

Expand Down

0 comments on commit ee3c85f

Please sign in to comment.