fixed readme v0.1

This commit is contained in:
Felix Lohmeier 2017-02-27 00:56:46 +01:00
parent cfb09fdd84
commit 2cae04b38c
1 changed files with 4 additions and 1 deletions

View File

@ -1,6 +1,7 @@
## OpenRefine batch processing (openrefine-batch.sh) ## OpenRefine batch processing (openrefine-batch.sh)
Shell script to run OpenRefine on Windows, Linux or Mac in batch mode (import, transform, export). This bash script automatically... Shell script to run OpenRefine on Windows, Linux or Mac in batch mode (import, transform, export). This bash script automatically...
1. imports all data from a given directory into OpenRefine 1. imports all data from a given directory into OpenRefine
2. transforms the data by applying OpenRefine transformation rules from all json files in another given directory and 2. transforms the data by applying OpenRefine transformation rules from all json files in another given directory and
3. finally exports the data in TSV (tab-separated values) format. 3. finally exports the data in TSV (tab-separated values) format.
@ -17,7 +18,7 @@ It orchestrates a [docker container for OpenRefine](https://hub.docker.com/r/fel
Linux: Linux:
1. Install [Docker](https://docs.docker.com/engine/installation/#on-linux) 1. Install [Docker](https://docs.docker.com/engine/installation/#on-linux)
2. Open Terminal and enter `wget https://.../openrefine-batch.sh && chmod +x ./openrefine-batch.sh` 2. Open Terminal and enter `wget https://github.com/felixlohmeier/openrefine-batch/raw/master/openrefine-batch.sh && chmod +x openrefine-batch.sh`
Mac: Mac:
@ -38,6 +39,8 @@ Windows:
#### Example #### Example
clone or [download GitHub repository](https://github.com/felixlohmeier/openrefine-batch/archive/master.zip) to get example data
``` ```
./openrefine-batch.sh examples/powerhouse-museum/input/ examples/powerhouse-museum/config/ examples/powerhouse-museum/output/ 4G tsv --processQuotes=false --guessCellValueTypes=true ./openrefine-batch.sh examples/powerhouse-museum/input/ examples/powerhouse-museum/config/ examples/powerhouse-museum/output/ 4G tsv --processQuotes=false --guessCellValueTypes=true
``` ```