docs: update link to project page
[m6w6/gitweb-theme] / README.markdown
index d4d6b63e5fd34f4e3e52a005dd4b2552b66efc95..503fae214d60e93304ccfebd6262ed86eb23df44 100644 (file)
@@ -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:
@@ -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