Skip to content

Commit 8011225

Browse files
committed
docs: Update README
1 parent 6f800bd commit 8011225

1 file changed

Lines changed: 12 additions & 13 deletions

File tree

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1+
# Redmine Time Tracking (Chrome Extension / Firefox Extension)
2+
13
![License](https://img.shields.io/github/license/CrawlerCode/redmine-time-tracking?logo=github)
24
[![Semantic-Release](https://img.shields.io/badge/semantic--release-conventional%20commits-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
35
![Release Version](https://img.shields.io/github/v/release/CrawlerCode/redmine-time-tracking?logo=github)
4-
![GitHub Release Date](https://img.shields.io/github/release-date/CrawlerCode/redmine-time-tracking?logo=github)
56
![Pre-Release Version](https://img.shields.io/github/v/release/CrawlerCode/redmine-time-tracking?include_prereleases&logo=github&label=pre-release)
67

78
![Chrome Web Store Version](https://img.shields.io/chrome-web-store/v/ldcanhhkffokndenejhafhlkapflgcjg?logo=google-chrome&logoColor=white)
@@ -12,9 +13,7 @@
1213
![Mozilla Add-on Users](https://img.shields.io/amo/users/redmine-time-tracking?logo=firefox-browser&logoColor=white)
1314
![Mozilla Add-on Rating](https://img.shields.io/amo/stars/redmine-time-tracking?logo=firefox-browser&logoColor=white)
1415

15-
# Redmine Time Tracking (Chrome Extension / Firefox Extension)
16-
17-
> Start-stop timer for [Redmine](https://www.redmine.org/).
16+
> Start-stop timer for [Redmine (open source project management web application)](https://www.redmine.org)
1817
1918
[![Install-Button-Chrome]][Install-Link-Chrome]
2019
[![Install-Button-Firefox]][Install-Link-Firefox]
@@ -24,22 +23,22 @@
2423
[Install-Button-Firefox]: https://img.shields.io/badge/Install-71b500?style=for-the-badge&logoColor=white&logo=firefox-browser
2524
[Install-Link-Firefox]: https://addons.mozilla.org/de/firefox/addon/redmine-time-tracking "Open in firefox add-on store"
2625

27-
# Features
26+
# 🚀 Features
2827

2928
- View all your assigned Redmine issues grouped by projects
30-
- Filter issues by projects
29+
- Filter issues by project and status
3130
- Group issues by target version
32-
- Search for issues (press `CTRL` + `K` or `CTRL` + `F`)
33-
- Start, stop and edit the timer for your current tasks
34-
- Create entry for time spent (and for multiple users at once)
31+
- Search for issues (`CTRL` + `K` or `CTRL` + `F`)
32+
- Start, stop and edit timers for your tasks
33+
- Create time entries (also for multiple users at once)
3534
- Update done ratio for issues
36-
- Pin and unpin issues (display at the top of the project)
35+
- Pin and unpin issues (display at the top)
3736
- Remember and forget issue (not assigned to you)
3837
- View time entries for current and last week
3938
- Multiple languages
4039
- Dark & light mode (system default)
4140

42-
# Requirements
41+
# 🛠️ Requirements
4342

4443
Supported browsers:
4544

@@ -62,7 +61,7 @@ At least **Redmine version `3.0` or higher** required. Recommended version `5.0`
6261
| Display project-available time entry activities when _adding spent time entries_ | `< 3.4.0` |
6362
| Remote Redmine search | `< 3.3.0` |
6463

65-
# Supported languages
64+
# 🌐 Supported languages
6665

6766
- English
6867
- German
@@ -71,7 +70,7 @@ At least **Redmine version `3.0` or higher** required. Recommended version `5.0`
7170

7271
> If you want to add more languages or extend existing ones, feel free to contribute. Just create a pull request with the desired changes. The language files are located under [src/lang](src/lang) and [public/\_locales](public/_locales).
7372
74-
# Screenshots
73+
# 📸 Screenshots
7574

7675
![issues](screenshots/en/dark/issues.png)
7776
![issues-time](screenshots/en/dark/time.png)

0 commit comments

Comments
 (0)