From 167ddd45799833dca9fb27d419cfeb6abe183856 Mon Sep 17 00:00:00 2001 From: Julien Oculi Date: Mon, 15 Jan 2024 23:45:27 +0100 Subject: [PATCH] doc: improve README informations --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index edd8197..43968df 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@ Create Redmine users from CSV and add users to a group. ⚠️ This project is only a draft, it's working but not intended to be use widely ⚠️ +Binaries are placed in `dist/` for x64. + +- "*": linux +- "*.exe": windows + +Script can be run directly with `deno task start` for other architectures or +compile with `deno task compile` using [deno](https://deno.com/). + ### Requirements The users CSV file must be in utf-8 using "," or ";" as separator. The required @@ -22,17 +30,17 @@ bob;parraut;bob.parraut@example.com ### Get help ```sh -./redmine-csv-loader --help +./dist/redmine-csv-loader --help ``` ### Create users ```sh -./redmine-csv-loader ./path/to/csv -k "my_api_key" +./dist/redmine-csv-loader ./path/to/csv -k "my_api_key" ``` ### Add existing users to a group ```sh -./redmine-csv-loader ./path/to/csv -k "my_api_key" -a -g "my_group" +./dist/redmine-csv-loader ./path/to/csv -k "my_api_key" -a -g "my_group" ```