From a2b921895b5513c77bf45293840588f08dbdd14f Mon Sep 17 00:00:00 2001 From: Felix Lohmeier Date: Wed, 20 Apr 2022 10:08:05 +0200 Subject: [PATCH] elaborate on features and requirements --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9fa5b51..431906a 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,23 @@ Bash script to control OpenRefine via [its HTTP API](https://docs.openrefine.org ## Features * works with latest OpenRefine version (currently 3.5) -* nested sub-commands with help screens and usage examples -* batch processing (import, transform, export) with temporary workspaces; your existing OpenRefine data will not be touched +* batch processing (import, transform, export) + * orcli takes care of starting and stopping OpenRefine with temporary workspaces + * your existing OpenRefine data will not be touched * import CSV, ~~TSV, line-based TXT, fixed-width TXT, JSON or XML~~ (and specify input options) -* transform data by providing an [undo/redo](https://docs.openrefine.org/manual/running#history-undoredo) JSON file; orcli calls specific endpoints for each operation to provide improved error handling and logging + * supports stdin, multiple files and URLs +* transform data by providing an [undo/redo](https://docs.openrefine.org/manual/running#history-undoredo) JSON file + * orcli calls specific endpoints for each operation to provide improved error handling and logging + * supports stdin, multiple files and URLs * export to TSV, ~~CSV, HTML, XLS, XLSX, ODS~~ * ~~[templating export](https://docs.openrefine.org/manual/exporting#templating-exporter) to additional formats like JSON or XML~~ ## Requirements -* GNU/Linux with Bash -* [jq](https://stedolan.github.io/jq/) -* [curl](https://curl.se/) +* GNU/Linux with Bash 4+ +* [jq](https://stedolan.github.io/jq) +* [curl](https://curl.se) +* [OpenRefine](https://openrefine.org) 😉 ## Install