Browse Source

docs(readme): update about and getting started

Josh Habdas 1 year ago
parent
commit
02a0cbf09d
Signed by: Josh Habdas <jhabdas@protonmail.com> GPG Key ID: B148B31154C75A74
1 changed files with 8 additions and 8 deletions
  1. 8
    8
      README.md

+ 8
- 8
README.md View File

@@ -13,7 +13,7 @@
13 13
 
14 14
 ## About
15 15
 
16
-After Dark is a Hugo theme designed for Web syndication. It is an original work created to preserve the aesthetic and design simplicity of hobbiest websites created during the mid- to late-1990’s. The theme includes an inbuilt search engine, POSIX-compliant quick installer, online help and optional plug-in modules to add functionality. Use it online or off to create anything from an indie microblog to a visually stunning photojournal.
16
+After Dark is a Hugo theme designed to facilitate content distribution. It is an original work created to preserve the aesthetic and simplicity of hobbiest websites created during the mid- to late-1990’s. The theme includes an inbuilt search engine, portable quick installer, online help and optional plug-in modules to enhance functionality. Use it online or off to create anything from an indie microblog to a visually stunning photojournal.
17 17
 
18 18
 ## Demo
19 19
 
@@ -32,8 +32,8 @@ Quick Installer | One command is all you need to get started with After Dark.
32 32
 Online Help | Learn to use the theme with convenient help from within your site.
33 33
 Module System | Add functionality with prebuilt modules designed to compliment your site.
34 34
 Section Menu | Display an accessible site-wide navigation with links to content sections.
35
-Display Variants | Customize look-and-feel with one of six included display variations.
36
-Custom Styles | Add to, override or disable theme styles for complete design control.
35
+Display Variants | Customize look-and-feel with one of eight included display variations.
36
+Custom Styles | Add to, adjust or disable theme styles for complete design control.
37 37
 Trim Color | Define how user agents should display the border around your site.
38 38
 SVG Favicon | Help push browser standards forward by decorating your site with an SVG favicon.
39 39
 Fuzzy Search | Find and share indexable content anywhere on your site. No registration required.
@@ -61,23 +61,23 @@ After Dark requires Hugo `0.44` or later. Before running the quick installer ple
61 61
 
62 62
 ### Quick Installer
63 63
 
64
-Then run the quick installer located at [`bin/install`](https://git.habd.as/comfusion/after-dark/src/branch/master/bin/install), or just paste this into a terminal and press <kbd>Enter</kbd>:
64
+Then run the quick installer located at [`bin/install`](https://git.habd.as/comfusion/after-dark/src/branch/master/bin/install), or just paste this into a POSIX terminal and press <kbd>Enter</kbd>:
65 65
 
66 66
 ```shell
67 67
 wget -qO - https://git.habd.as/comfusion/after-dark/raw/branch/master/bin/install | sh
68 68
 ```
69 69
 
70
-Installation should complete in a matter of seconds and includes documentation to get you started.
70
+Installation should complete in a matter of seconds resulting in a functional offline website ready to go live.
71 71
 
72 72
 ### Go Live
73 73
 
74
-View your site online with [Serveo] using end-to-end encryption:
74
+Serve your site online with end-to-end encryption using [Serveo], no sign-up required:
75 75
 
76 76
 ```
77
-ssh -R 80:localhost:1313 serveo.net
77
+hugo serve --disableLiveReload & ssh -R 80:localhost:1313 serveo.net
78 78
 ```
79 79
 
80
-No sign-ups required. Install [dropbear] or [openssh] if you need an ssh server.
80
+Once started press `g` for traffic inspection, or quit to go offline and use `fg` to return to `hugo`. Install [dropbear] or [openssh] if you need `ssh`.
81 81
 
82 82
 ## Adaptations
83 83
 

Loading…
Cancel
Save