diff --git a/README.md b/README.md index 48e05d7..64e555c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,29 @@ # pulp - +![logo](https://user-images.githubusercontent.com/17229643/45928032-f0658a80-bf77-11e8-91a0-00a267e75c6e.png) Pulp is theme of Hugo framework for realize simple and readable blog. +## Screenshots +![screenshot-home](https://user-images.githubusercontent.com/17229643/45927910-06724b80-bf76-11e8-81b4-bbc11114117d.png) +![screenshot-list](https://user-images.githubusercontent.com/17229643/45927916-2d308200-bf76-11e8-9428-a487b4ae7901.png) +![screenshot-page](https://user-images.githubusercontent.com/17229643/45927928-551fe580-bf76-11e8-89dd-9ef80e777f72.png) + +## Install and Use theme +1. Inside the folder of your Hugo site run: + +``` +cd themes +git submodule add https://github.com/koirand/pulp.git pulp +``` + +2. Configure your config.toml with reference to exampleSite. +3. Build your site with `hugo server`. + +### Additional information +For more information, read the official [guide](https://gohugo.io/themes/installing-and-using-themes/) of Hugo. + +### Update the theme +If you have installed the theme as a git submodule, you can update the theme by issuing the following command inside your project folder. + +``` +git submodule update --remote --rebase +```