Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/lasseborly/anybodyhome.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLasse Borly <contact@lasseborly.dk>2016-09-08 01:00:50 +0300
committerLasse Borly <contact@lasseborly.dk>2016-09-08 01:00:50 +0300
commita75af4e252639df47bcab7b5cebdce736880186c (patch)
treebe8f90f0c47dab7d5e65c2d32b225168b22ae6c1 /README.md
parentd891e12f4580e3a840b461f28da358d79e18fab8 (diff)
added subtitle and bettered readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 44 insertions, 2 deletions
diff --git a/README.md b/README.md
index 58e6150..1bcaca4 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,47 @@
-#Anybody Home?
+# Anybody Home?
A simple theme for simple people with simple needs.
-The focus of the theme is using as few dependencies as possible to keep the layout simple and feature sparse.
+The focus of the theme is using as few dependencies as possible to keep the layout simple and bloat free.
+
+## Features
+* __Blog only__ - Only a list of the 10 most recent posts and added pagination. There is no other pages than the main page and the post page.
+* [__Highlight.js__](https://highlightjs.org/) - For all of you code needs.
+
+## Getting Started
+From the root of you Hugo site clone the theme into `themes/anybodyhome` by running:
+
+`git clone https://github.com/lasseborly/anybodyhome.git themes/anybodyhome`
+
+## Usage
+To use Anybody Home? you must first, from the root of your Hugo site, run either:
+
+`hugo -t anybodyhome`
+
+or set in you `config.toml`.
+
+`theme = "anybodyhome"`
+
+## Configuration
+You can set the normal Hugo site variables in your `config.toml` but there is also some custom Anybody Home? variables you can set. This is an example of a full `config.toml`.
+
+```toml
+theme = "anybodyhome"
+baseurl = "https://hugosite.com"
+languageCode = "en-us"
+title = "Anybody Home?"
+
+[params]
+ subtitle = "A Simple Theme"
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch - `git checkout -b my-new-feature-or-fix`
+3. Commit your changes - `git commit -am 'Add some feature-or-fix'`
+4. Push to the branch - `git push origin my-new-feature-or-fix`
+5. Create new Pull Request
+
+## Extra
+Take a look at my [docker setup](https://github.com/lasseborly/hugo-development) for developing with Hugo. It's, again, very simple, straight forward and open for contributions.