diff --git a/README.md b/README.md index 4b79b40..c644398 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,25 @@ A theme for [Hugo](https://gohugo.io/), inspired by Atom editor. Changelog [here](https://github.com/aubm/hugo-code-editor-theme/blob/master/CHANGELOG.md) :) +# Installation + +Install using `git clone https://github.com/aubm/hugo-code-editor-theme.git /path/to/your/site/themes/code-editor`. + +For more information read the official [setup guide](https://gohugo.io/overview/installing/) of Hugo. + +You will need to define the `locale` parameter in order to use this theme. +Please have a look at this configuraton sample : + +``` +baseurl = "http://your-site.com" +languageCode = "en-US" +title = "Your site" +theme = "code-editor" + +[params] + locale = "en-US" +``` + # Contributing Contributions are welcome. Please refer to the [contributions guidelines](https://github.com/aubm/hugo-code-editor-theme/blob/master/CONTRIBUTING.md) for more information.