Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jimsmart committed Apr 17, 2021
1 parent d23a148 commit 5a19d82
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 27 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@
[![Used By](https://img.shields.io/sourcegraph/rrc/github.com/jimsmart/peanut.svg)](https://sourcegraph.com/github.com/jimsmart/peanut)
[![Godoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://godoc.org/github.com/jimsmart/peanut)

peanut writes data structs without ceremony in a variety of formats.
peanut is a [Go](https://golang.org/) package to write tagged data structs in a variety of formats.

Its primary purpose is to provide a single consistent interface
for easy, ceremony-free persistence of record-based struct data.

## About

Expand All @@ -23,7 +26,7 @@ Get the package:
go get github.com/jimsmart/peanut
```

Use the package within your code (see examples below):
Use the package within your code:

```go
import "github.com/jimsmart/peanut"
Expand Down
23 changes: 0 additions & 23 deletions TODO
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,8 @@ TODO
====


- Supported data types
- string
- bool
- float64
- float32
- int
- int8
- int16
- int32
- int64
- uint
- uint8
- uint16
- uint32
- uint64


- Improve the examples in Godocs.



- Writers
- Should writers throw an error if the given type to write has no tagged fields?
- Or should they simply fall back to using field names when tags are not present?


- Logging for CSV and Excel writers on completion, detailing files written?
Expand All @@ -37,7 +15,6 @@ TODO
- On second thoughts, it may simplify some of our code.



New writer types
----------------

Expand Down
4 changes: 2 additions & 2 deletions doc.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Package peanut writes data structs in a variety of formats.
// Package peanut writes tagged data structs in a variety of formats.
// Its primary purpose is to provide a single consistent interface
// for easy, ceremony-free persistence of struct data.
// for easy, ceremony-free persistence of record-based struct data.
//
// Each distinct struct type sent to Write() is written to an individual file/table,
// each named according to the name of the struct.
Expand Down

0 comments on commit 5a19d82

Please sign in to comment.