diff --git a/README.md b/README.md index 13e9f8a..ef4a14f 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,22 @@ ## lean hugo theme -This is lean hugo theme, a port of the lean jekyll theme. +This is lean hugo theme, a port of the [lean jekyll theme][lean-jekyll]. ## Usage Inside a hugo site, do - $ git submodule add http://framagit.org/lafleur/lean-hugo-theme.git + $ git submodule add http://framagit.org/lafleur/lean-hugo-theme.git themes/lean + $ cd themes/lean + $ git checkout master + +To update the theme to its latest version, inside the hugo site do + + $ git submodule update themes/lean ## Contributing - This project is intended to be a welcoming space for collaboration. If you have an idea, suggestion, feature request, etc., feel free to open an issue or pull request. + +[lean-jekyll]: https://gitlab.com/lafleurdeboum/lean-jekyll-theme +