customize git.m6w6.name

[m6w6/gitweb-theme] / README.markdown

diff --git a/README.markdown b/README.markdown
index d4d6b63e5fd34f4e3e52a005dd4b2552b66efc95..2eed141746c42a634c6c26e13300b2ecfbc19514 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -1,3 +1,7 @@
+![Maintenance](https://img.shields.io/maintenance/yes/2018.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.
@@ -54,7 +58,14 @@ $feature{'avatar'}{'default'} = ['gravatar'];
 
 ### 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