Skip to content

Commit 6e1ff78

Browse files
committed
Update meta-data for upcoming 0.5.1 release
1 parent f12b9fb commit 6e1ff78

File tree

3 files changed

+38
-11
lines changed

3 files changed

+38
-11
lines changed

Data/Csv/Builder.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{-# LANGUAGE ScopedTypeVariables #-}
22

33
-- | Low-level bytestring builders. Most users want to use the more
4-
-- type-safe 'Data.Csv.Incremental' module instead.
4+
-- type-safe "Data.Csv.Incremental" module instead.
55
module Data.Csv.Builder
66
(
77
-- * Encoding single records and headers

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
[![Hackage](https://img.shields.io/hackage/v/cassava.svg)](https://hackage.haskell.org/package/cassava) [![Build Status](https://travis-ci.org/hvr/cassava.svg)](https://travis-ci.org/hvr/cassava)
44

5-
A CSV parsing and encoding library optimized for ease of use and high
6-
performance.
5+
**See [package description](https://hackage.haskell.org/package/cassava#description).**
76

87
## Usage example
98

cassava.cabal

Lines changed: 36 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,33 @@
1+
cabal-version: 1.12
12
Name: cassava
23
Version: 0.5.1.0
34
Synopsis: A CSV parsing and encoding library
4-
Description:
5-
A CSV parsing and encoding library optimized for ease of use and high
6-
performance.
5+
Description: {
6+
7+
@cassava@ is a library for parsing and encoding [RFC 4180](https://tools.ietf.org/html/rfc4180)
8+
compliant [comma-separated values (CSV)](https://en.wikipedia.org/wiki/Comma-separated_values) data,
9+
which is a textual line-oriented format commonly used for exchanging tabular data.
10+
.
11+
@cassava@'s API includes support for
12+
.
13+
- Index-based record-conversion
14+
- Name-based record-conversion
15+
- Typeclass directed conversion of fields and records
16+
- Built-in field-conversion instances for standard types
17+
- Customizable record-conversion instance derivation via GHC generics
18+
- Low-level [bytestring](https://hackage.haskell.org/package/bytestring) builders (see "Data.Csv.Builder")
19+
- Incremental decoding and encoding API (see "Data.Csv.Incremental")
20+
- Streaming API for constant-space decoding (see "Data.Csv.Streaming")
21+
.
22+
Moreover, this library is designed to be easy to use; for instance, here's a
23+
very simple example of encoding CSV data:
24+
.
25+
>>> Data.Csv.encode [("John",27),("Jane",28)]
26+
"John,27\r\nJane,28\r\n"
27+
.
28+
Please refer to the documentation in "Data.Csv" and the included [README](#readme) for more usage examples.
29+
30+
}
731
Homepage: https://github.com/hvr/cassava
832
License: BSD3
933
License-file: LICENSE
@@ -15,15 +39,19 @@ Author: Johan Tibell
1539
Maintainer: [email protected]
1640
Category: Text, Web, CSV
1741
Build-type: Simple
18-
Cabal-version: >=1.10
1942
Extra-source-files: examples/*.hs,
20-
CHANGES.md
43+
CHANGES.md,
44+
README.md
2145
Tested-with: GHC ==8.2.1, GHC ==8.0.2, GHC ==8.0.1, GHC ==7.10.3, GHC ==7.8.4, GHC ==7.6.3, GHC ==7.4.2
2246

2347
----------------------------------------------------------------------------
2448

25-
flag pre-bytestring-0-10-4
26-
description: bytestring < 0.10.4
49+
source-repository head
50+
type: git
51+
location: https://github.com/hvr/cassava
52+
53+
flag bytestring--LT-0_10_4
54+
description: [bytestring](https://hackage.haskell.org/haskell/package) < 0.10.4
2755

2856
Library
2957
default-language: Haskell2010
@@ -77,7 +105,7 @@ Library
77105
vector >= 0.8 && < 0.13,
78106
Only >= 0.1 && < 0.1.1
79107

80-
if flag(pre-bytestring-0-10-4)
108+
if flag(bytestring--LT-0_10_4)
81109
build-depends: bytestring < 0.10.4
82110
, bytestring-builder >= 0.10.8 && < 0.11
83111
else

0 commit comments

Comments
 (0)