Browse code

Updated README

Renamed the repo, so the links are now different. Also, made more explicit that this is a fork of After Dark.

Julio Biason authored on 08/01/2019 06:59:42 • GitHub committed on 08/01/2019 06:59:42
Showing 1 changed files

... ...
@@ -1,6 +1,8 @@
1
-# after-dark
1
+# nighttime
2 2
 
3
-![after-dark screenshot](https://github.com/getzola/after-dark/blob/master/screenshot.png?raw=true)
3
+This is a fork of [After Dark](https://github.com/getzola/after-dark/), a theme for [Zola](https://www.getzola.org/), with aditional suppot for tags and sections.
4
+
5
+![after-dark screenshot](https://github.com/jbiason/nighttime/blob/master/screenshot.png?raw=true)
4 6
 
5 7
 ## Contents
6 8
 
... ...
@@ -14,12 +16,12 @@ First download this theme to your `themes` directory:
14 16
 
15 17
 ```bash
16 18
 $ cd themes
17
-$ git clone https://github.com/getzola/after-dark.git
19
+$ git clone https://github.com/jbiason/nighttime.git
18 20
 ```
19 21
 and then enable it in your `config.toml`:
20 22
 
21 23
 ```toml
22
-theme = "after-dark"
24
+theme = "nighttime"
23 25
 ```
24 26
 
25 27
 This theme requires your index section (`content/_index.md`) to be paginated to work:
... ...
@@ -45,7 +47,12 @@ as it only works for non-paginated taxonomies by default.
45 47
 
46 48
 ## Options
47 49
 
50
+Because this is, mostly, After Dark with support for extra stuff, it still uses the same options as After Dark.
51
+
52
+If you're already using After Dark, there are no changes in your configs that need to be done, besides changing the theme name.
53
+
48 54
 ### Top-menu
55
+
49 56
 Set a field in `extra` with a key of `after_dark_menu`:
50 57
 
51 58
 ```toml