Skip to content

Commit 9c2e7c5

Browse files
Documenatation
1 parent c6cfc38 commit 9c2e7c5

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,27 @@
77
[![Codebase](https://img.shields.io/badge/codebase-github-brightgreen)](https://github.com/frictionlessdata/tableschema-java)
88
[![Support](https://img.shields.io/badge/support-discord-brightgreen)](https://discordapp.com/invite/Sewv6av)
99

10-
A Java library for working with Table Schema. Snapshots on [Jitpack](https://jitpack.io/#frictionlessdata/tableschema-java).
11-
tableschema-java is a library aimed at parsing CSV and JSON-Array documents into a tabular format according
10+
A Java library for working with Table data.
11+
**tableschema-java** is a library aimed at parsing CSV and JSON-Array documents into a live Java objects according
1212
to [Table Schema](https://frictionlessdata.io/specs/table-schema/), a format definition based on
1313
[JSON Schema](https://json-schema.org/understanding-json-schema/).
1414

1515
It allows you to read and write tabular data with assurances to format integrity (it also allows reading and writing
16-
CSV free-form, ie. without a Schema).
16+
CSV free-form, ie. without a Schema). And finally, it converts Java POJOs to and from CSV, similar to Jackson for JSON
17+
(mostly).
18+
19+
It was conceived by the guys at [Frictionless Data](frictionlessdata.io)
20+
21+
Please find releases on [Jitpack](https://jitpack.io/#frictionlessdata/tableschema-java)
1722

1823
## Usage
24+
25+
OK, enough of the PR, how do I actually use that thing. It's not like you are the only CSV parser,
26+
so show me the goods.
1927
- [Reading data](docs/table-reading.md) explains various ways of reading data
20-
- [Via Java Beans](docs/table-reading.md#reading-tabular-data-the-java-way) via a Java Bean class
21-
- [Without a Schema](docs/table-reading.md#reading-tabular-data-without-a-schema) Read as Object arrays and without
28+
- [Via Java Beans](docs/table-reading.md#reading-tabular-data-the-java-way) for minimal friction
29+
if you already have a domain model
30+
- [Without a Schema](docs/table-reading.md#reading-tabular-data-without-a-schema) Read as String arrays and without
2231
format integrity assurance
2332
- [With a Schema](docs/table-reading.md#reading-tabular-data-using-a-schema) Read as converted Java object arrays with
2433
format integrity assurance
@@ -30,8 +39,7 @@ CSV free-form, ie. without a Schema).
3039
- Validating data: Parsing string data to Field values (casting)
3140
- [Row Casting](docs/casting.md#row-casting) to check String arrays against a Schema
3241
- [Field Casting](docs/casting.md#field-casting) to check Strings against a Field definition
33-
34-
42+
3543
## Contributing
3644

3745
Found a problem and would like to fix it? Have that great idea and would love to see it in the repository?
@@ -46,7 +54,7 @@ This project follows the [Open Knowledge International coding standards](https:/
4654

4755
Get started:
4856
```sh
49-
# install jabba and maven2
57+
# install Java 1.8 or higher (use Jabba if you need to test on different versions) and maven2
5058
$ cd tableschema-java
5159
$ jabba install 1.8
5260
$ jabba use 1.8

0 commit comments

Comments
 (0)