julien.oculi/draft-redmine_users_from_csv
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

doc: improve README informations

Browse source
This commit is contained in:
Julien Oculi 2024-01-15 23:45:27 +01:00
parent 098c10063e
commit 167ddd4579
1 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -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"
```