doc: improve README informations
This commit is contained in:
parent
098c10063e
commit
167ddd4579
14
README.md
14
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 ⚠️
|
⚠️ 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
|
### Requirements
|
||||||
|
|
||||||
The users CSV file must be in utf-8 using "," or ";" as separator. The required
|
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
|
### Get help
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
./redmine-csv-loader --help
|
./dist/redmine-csv-loader --help
|
||||||
```
|
```
|
||||||
|
|
||||||
### Create users
|
### Create users
|
||||||
|
|
||||||
```sh
|
```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
|
### Add existing users to a group
|
||||||
|
|
||||||
```sh
|
```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"
|
||||||
```
|
```
|
||||||
|
|
Loading…
Reference in a new issue