README.md aktualisiert

README.md

@@ -1,3 +1,27 @@
 # Gitea-time-tracker
 
-Tool to calculate total time spent by a singl user on a Gitea repository.
+Tool to calculate total time spent by a single user on a Gitea repository.  
+The tool is running exclusivly in your browser and no data will leave your computer.
+
+# Preparation
+
+- create an access token with permission to read repository
+- Query the API to receive a JSON text including all the timestamps: https://your-gitea-server/api/v1/repos/{ownerName}/{repoName}/times/{userName}?access_token={apiAccessToken}
+  * {ownerName} = name of the repository owner; might be a user name or organization name
+  * {repoName} = name of the repository to evaluate
+  * {userName} = name of the user to evaluate
+  * {apiAccessToken} = the access token you prepared in the first step
+
+# Calculate the total time and cost
+
+- open [timetracker.html](timetracker.html)
+- set your "cost per hour" factor for proper cost calculation
+- paste the JSON text you queried from Gitea's API into the text area
+- press the "parse" button
+- results will be displayed and inputs hidden
+- to restart: reload the page
+
+# License
+
+This software is licensed under the [EUROPEAN UNION PUBLIC LICENCE v. 1.2 (EUPL-1.2)](LICENSE).
+