Skip to content

Commit 3f60d60

Browse files
committed
[ISSUE-4] Closes #4
Signed-off-by: Jacek Ciwiś <jacek.ciwis@gmail.com>
1 parent 3a09242 commit 3f60d60

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# toggle-to-jira
1+
# toggl-to-jira
22

3-
### What is toggle-to-jira?
4-
Toggl-to-jira is an application which allows you to migrate toggle time entries into multiple jira instances.
3+
### What is toggl-to-jira?
4+
Toggl-to-jira is an application which allows you to migrate toggl time entries into multiple jira instances.
55

66
### How it works?
7-
Toggl-to-jira takes toggle time entries from the given time period and it creates workloads in related jira issues. To work properly each toogle timeentry has to be assigned to the client. Base on this assignment and app configuration, application recognize in which jira instance should create workloads.
7+
Toggl-to-jira takes toggl time entries from the given time period and it creates workloads in related jira issues. To work properly each toogle timeentry has to be assigned to the client. Base on this assignment and app configuration, application recognize in which jira instance should create workloads.
88

99
### Installation
1010

@@ -39,7 +39,7 @@ Linux
3939
toggl-to-jira
4040
```
4141
it will generate configuration at `$HOME/.toggl-to-jira/config.yaml`
42-
```
42+
```yaml
4343
default_client:
4444
jira_client_user: firstname.lastname
4545
jira_host: https://jira.atlassian.net
@@ -54,7 +54,7 @@ log_output: stdout
5454
period: 1
5555
toggl_token: (visit https://www.toggl.com/app/profile)
5656
```
57-
2. Adjust following keys
57+
2. Adjust following keys:
5858
- default_client.jira_client_user
5959
- default_client.jira_host
6060
- default_client.jira_password
@@ -69,15 +69,15 @@ toggl_token: (visit https://www.toggl.com/app/profile)
6969
INFO[0000] Customize configuration in file: /Users/jacekciwis/.toggl-to-jira/config.yaml
7070
INFO[0000] Start processing 1478671803: ISSUE-123 Work description
7171
51m32s - toggl value
72-
52m0s - stachursky mode (m)
72+
52m0s - stachursky mode (1m)
7373
7474
Workload details:
7575
Time spent: 50m0s
7676
Comment: ISSUE-123 Work description
7777
Issue url: https://jira.atlassian.net/browse/ISSUE-123
7878
```
7979
4. Configuration for missing clients will be autogenerated
80-
```
80+
```yaml
8181
client:
8282
client_foo:
8383
enabled: true
@@ -89,10 +89,10 @@ toggl_token: (visit https://www.toggl.com/app/profile)
8989
You can overwrite default_client configuration here
9090
9191
5. If everything is correct, run with the `--apply` flag
92-
```
92+
```bash
9393
toggl-to-jira --apply
9494
```
95-
```
95+
```bash
9696
INFO[0000] Checking configuration...
9797
INFO[0000] Customize configuration in file: $HOME/.toggl-to-jira/config.yaml
9898
INFO[0000] Start processing 1478671803: ISSUE-123 Work description
@@ -101,6 +101,6 @@ toggl_token: (visit https://www.toggl.com/app/profile)
101101
INFO[0001] Issue url: https://jira.atlassian.net/browse/ISSUE-123
102102
INFO[0002] Finish processing 1478671803: ISSUE-123 Work description
103103
```
104-
6. After migration success toggle time entry will be tag with `jira_migration_success_tag` configuration key value (default: `logged`) - this tag causes skip on next migration
104+
6. After migration success toggl time entry will be tag with `jira_migration_success_tag` configuration key value (default: `logged`) - this tag causes skip on next migration
105105
7. If you want to skip some time entry migration, tag it with `jira_migration_skip_tag` configuration key value (default: `jira-migration-skip`)
106-
8. After migration fail toggle time entry will be tag with `jira_migration_failed_tag` configuration key value (default: `jira-migration-failed`) - this tag will be remove after migration success
106+
8. After migration fail toggl time entry will be tag with `jira_migration_failed_tag` configuration key value (default: `jira-migration-failed`) - this tag will be remove after migration success

0 commit comments

Comments
 (0)