Skip to content
This repository has been archived by the owner on Feb 22, 2024. It is now read-only.

Commit

Permalink
reogranize readme
Browse files Browse the repository at this point in the history
  • Loading branch information
andreybratus committed Mar 29, 2015
1 parent f1315eb commit e322495
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ To list the `backend_specific_options`:
**Run the [P3 Transformer](#p3-transformer)**

```sh
./bin/transformer.sh [TRANSFORMER_OPTIONS] BACKEND_TYPE [backend_specific_options]
./bin/transformer [TRANSFORMER_OPTIONS] BACKEND_TYPE [backend_specific_options]
```

`TRANSOFRMER_OPTIONS` are:
Expand Down Expand Up @@ -179,9 +179,14 @@ and [P3 Transformer](#p3-transformer)

Command Line Tool
=================
Unfortunately, the command line tool has to be built from sources.
Read the section on [building BatchRefine from sources](#building-from-sources) for
instructions on how to do it.


The HTTP API is convenient for integrating BatchRefine as a service,
but clumsy for manual usage. The command line tool works better in
but clumsy for manual usage.
The command line tool works better in
these cases, as you can simply do:

```sh
Expand All @@ -192,11 +197,7 @@ where, as before, `input.csv` is the input file, `transform.json` is
the transform script and `output.csv` is the output file to which to
write the transformed data.

## Building

Unfortunately, the command line tool has to be built from
sources. Read the section on building BatchRefine from sources for
instructions on how to do it.

## Running With the Embedded Backend

Expand All @@ -211,7 +212,7 @@ you do not need to start OpenRefine to actually use it.
this will produce a CSV file on stdout with the transform applied to
it.

### Limitations of the embedded engine
#### Limitations of the embedded engine

The embedded engine cannot currently do reconciliation, and extensions
require customization to work (i.e. the RDF extension won't work out
Expand Down Expand Up @@ -241,7 +242,7 @@ to split your file in half:
the Batchrefine `split` backend will split an input file in 2 chunks, upload them to available OpenRefine
instances and handle the reassembling of the result.
### Command line options of split backend:
#### Command line options of split backend:
To get the list of available options, use `--help` option.
```
Expand Down

0 comments on commit e322495

Please sign in to comment.