From e60bf5feedb04aaa982be77a459efa4a549c987c Mon Sep 17 00:00:00 2001 From: Ryan Date: Sat, 1 Oct 2016 14:15:09 +0200 Subject: [PATCH] modified readme --- README.md | 35 +++++++++++++++++++++++++++++++++++ layouts/index.html | 2 +- theme.toml | 15 ++++++--------- 3 files changed, 42 insertions(+), 10 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..797f658 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +Last.fm Hugo Demo +================= + +This is a simple demo that shows how to use [last.fm](https://last.fm) with [hugo](https://gohugo.io). + +Installation +------------ + +Inside the folder of your Hugo site run: + + $ mkdir themes + $ cd themes + $ git clone https://github.com/alrayyes/lastfm-hugo-demo-theme + +For more information read the official [setup guide][setup_guide] of Hugo. + +### The Config File ### + +Add the following to your config.toml: + +```toml +[Params] +username = "" +apikey = "" +limit = "200" +``` + +Username is your [last.fm](https://last.fm) username and the limit is the number of scrobbles you want to see (max 200). You can get an api key by creating an api account [here](http://www.last.fm/api/account/create). + +[bootstrap]: https://getbootstrap.com/ +[momentjs]: http://momentjs.com/ +[jquery]: https://jquery.com/ +[issue_tracker]: https://github.com/alrayyes/lastfm-hugo-demo-theme/issues +[pull_request]: https://github.com/alrayyes/lastfm-hugo-demo-theme/pulls +[license]: https://github.com/chipsenkbeil/grid-side/blob/master/LICENSE \ No newline at end of file diff --git a/layouts/index.html b/layouts/index.html index c23ce2a..49ccfbd 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -18,7 +18,7 @@ -Fork me on GitHub +Fork me on GitHub

diff --git a/theme.toml b/theme.toml index 5a15d3e..5d7036d 100644 --- a/theme.toml +++ b/theme.toml @@ -1,13 +1,10 @@ -# theme.toml template for a Hugo theme -# See https://github.com/spf13/hugoThemes#themetoml for an example - -name = "Lastfmdemo" +name = "Lastfmhugodemo" license = "MIT" -licenselink = "https://github.com/alrayyes/lastfmdemo/blob/master/LICENSE.md" -description = "" -homepage = "http://siteforthistheme.com/" -tags = ["", ""] -features = ["", ""] +licenselink = "https://github.com/alrayyes/lastfm-hugo-demo-theme/blob/master/LICENSE.md" +description = "Theme that demonstrates Hugo & Last.fm api working together" +homepage = "https://github.com/alrayyes/lastfm-hugo-demo-theme" +tags = ["lastfm", "demo", "last.fm"] +features = ["lastfm", "last.fm"] min_version = 0.15 [author]