Skip to content

Commit fe1c0a8

Browse files
Small documentation tweaks (#11)
1 parent afaa7de commit fe1c0a8

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Neither Swift nor Apple's application libraries contain a standardised method of
1616

1717
## Features
1818

19+
I started out building this library loking for something which had a very specifically small feature set.
20+
1921
1. **Not coupled to root object structure.**
2022

2123
`Codable` is great but is limited to a single coding representation per object. It's also created with hierarchical representations – dictionaries and arrays inside other dictionaries or arries - in mind, whereas CSV is by its nature flat in structure.
@@ -59,6 +61,8 @@ Neither Swift nor Apple's application libraries contain a standardised method of
5961

6062
`SwiftCSVEncoder` only creates a string representation of the whole CSV file in memory. The calling application needs to handle saving the data to an appropriate location.
6163

64+
As `SwiftCSVEncoder` grows I expect it'll gain more features than those above. But the idea will always to keep it as simple as possible.
65+
6266
## Documentation and further reading
6367

6468
* **[Full documentation](https://swiftpackageindex.com/scottmatthewman/swiftcsvencoder/documentation/swiftcsvencoder)**

Sources/SwiftCSVEncoder/CSVEncoderConfiguration.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Foundation
99

1010
/// A set of decisions about how to encode data for a given ``CSVTable``.
1111
///
12-
/// Currently this is restricted solely to a strategy for encoding `Date` values.
12+
/// Currently this is covers strategies for encoding `Date` and `Bool` values.
1313
public struct CSVEncoderConfiguration {
1414
/// The strategy to use when encoding dates.
1515
///

0 commit comments

Comments
 (0)