docs: update link to project page

[m6w6/gitweb-theme] / README.markdown

diff --git a/README.markdown b/README.markdown
index 1bf6f3a3a64c6e16f1f54e600edef181e14e9e1c..503fae214d60e93304ccfebd6262ed86eb23df44 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -1,8 +1,12 @@
+![Maintenance](https://img.shields.io/maintenance/yes/2020.svg)
+![GitHub Stars](https://img.shields.io/github/stars/kogakure/gitweb-theme.svg?style=social&label=Star)
+![GitHub Forks](https://img.shields.io/github/forks/kogakure/gitweb-theme.svg?style=social&label=Fork)
+
 # Theme for gitweb
 
 This is an alternative theme for [gitweb] (tested with git web interface version 2.0.4). It is *strongly* inspired by GitHub.
 
-Fullsize screenshots available on [kogakure.github.com/gitweb-theme][gitweb-theme].
+Fullsize screenshots available on [kogakure.github.io/gitweb-theme][gitweb-theme].
 
 ## Installation
 The installation of this stylesheet is very easy:
@@ -10,12 +14,12 @@ The installation of this stylesheet is very easy:
 1. Clone the repository to a location of your choice `git clone https://github.com/kogakure/gitweb-theme.git`
 2. Run `./setup -vi --install` and your gitweb will be themed!
     - If you are on Ubuntu, then the script will default to gitweb's installation directory **/usr/share/gitweb/**.
-    - If this is not where gitweb is located, then pass the directory to the script with the --target or -t option.
+    - If this is not where gitweb is located, then pass the directory to the script with the `--target` or `-t` option.
 3. Of course you can just copy them to the new location too.
 
 If you see some missing things or errors, please create a ticket or fix it and send a pull request.
 
-### Configuration-File
+### Configuration file
 *Did you know?*
 
 Updating Gitweb can be quite time consuming because you have to adjust your settings in the `gitweb.cgi`. **You don’t have to!**.
@@ -35,14 +39,14 @@ $feature{'avatar'}{'default'} = ['gravatar'];
 $feature{'highlight'}{'default'} = [1];
 ```
 
-### Syntax-Highlighting
+### Syntax highlighting
 Optionally, you can enable syntax highlighting for your code. Install the highlight package with your package manager and add this line to /etc/gitweb.conf:
 
 ```perl
 $feature{'highlight'}{'default'} = [1];
 ```
 
-### Gravatar-Support
+### Gravatar support
 You can enable Gravatar support with this line:
 
 ```perl
@@ -50,11 +54,18 @@ $feature{'avatar'}{'default'} = ['gravatar'];
 ```
 
 [gitweb]: http://git.or.cz/gitwiki/Gitweb
-[gitweb-theme]: http://kogakure.github.com/gitweb-theme
+[gitweb-theme]: https://kogakure.github.io/gitweb-theme/
 
 ### Categories
 
-Gitweb supports categories, which can be enabled by adding a file to your Git-Repository: `.git/category`. In this file you write the name of the category. In the Gitweb interface they will get grouped by category.
+Gitweb and this theme support categories, which can be enabled by the following gitweb config option:
+
+```perl
+$projects_list_group_categories = true;¬
+```
+
+The category name for each repository is read from `.git/category`, in the same manner as `.git/description`.
+
 
 ## Setup Script