diff --git a/README b/README new file mode 100644 index 0000000..5576388 --- /dev/null +++ b/README @@ -0,0 +1,53 @@ +# Jiracula + +## 1. Install Tampermonkey: +https://www.tampermonkey.net + +## 2. Install Jiracula: + + * Point your browser to: + * https://www.nicsys.eu/jiracula/jiracula.user.js + * Accept script installation. + * It should now appear in Tampermonkey dashboard. + * Now go to Jira -> Tempo -> My work.\ + You should see the jiracula button when you are on **tempo** screen: + + ![](https://www.nicsys.eu/jiracula/scrshot1.png) + +`If it doesn't appear immediately after install, you might need to disable + re-enable the script in Tampermonkey dashboard.` + +## 3. Prepare your JSON file. + +Caution: +1. It must end with "**.jrcl.json**" for Jiracula to see it. +2. All task codes must exist (it won't create your tickets !!).\ +Entries with non-existing task codes will be skipped. + +``` +[ + { + "Date": "01/10/25", + "TaskCode": "SMEIMKT-12345", + "Duration": 1, + "Description": "Hello world" + }, + { + "Date": "01/10/25", + "TaskCode": "SMEIMKT-56789", + "Duration": 2.5, + "Description": "Did some testing of Jiracula and I love it." + }, + { + "Date": "01/10/25", + "TaskCode": "SMEIMKT-56789", + "Duration": 1, + "Description": "Meeting with colleagues about the wonders of Jiracula." + } +] +``` + + +## 4. Click Jiracula button, get your "**.jrcl.json**" file. +Let it do its magic until the progress bar dissapears.\ +**Now RELOAD THE PAGE**\ +You should now see your entries in your timesheet. diff --git a/scrshot1.png b/scrshot1.png new file mode 100644 index 0000000..4a4882d Binary files /dev/null and b/scrshot1.png differ