Browse Source

docs(readme): update principia, features and remove bpg cruft

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

+ 15
- 30
README.md View File

@@ -5,7 +5,7 @@
5 5
 [![Latest NPM version](https://img.shields.io/npm/v/after-dark.svg?style=flat-square)](https://www.npmjs.com/package/after-dark)
6 6
 [![NPM downloads per month](https://img.shields.io/npm/dm/after-dark.svg?style=flat-square)](https://www.npmjs.com/package/after-dark)
7 7
 [![Minimum Hugo version](https://img.shields.io/badge/hugo->%3D%200.44-FF4088.svg?style=flat-square)](https://gohugo.io)
8
-[![Telegram chat](https://img.shields.io/badge/chat-telegram-32AFED.svg?style=flat-square)](https://t.me/joinchat/Iw_6FEhmKL9sPUAukX9jzg)
8
+[![Telegram chat](https://img.shields.io/badge/chat-telegram-32AFED.svg?style=flat-square)][1]
9 9
 [![WTFPL licensed](https://img.shields.io/npm/l/after-dark.svg?style=flat-square&longCache=true)](https://git.habd.as/comfusion/after-dark/src/branch/master/COPYING)
10 10
 
11 11
 ![After Dark screenshots](https://git.habd.as/comfusion/after-dark/raw/branch/master/images/docs/minimal-mac-fs8.png)
@@ -16,27 +16,26 @@ Visit [Hack Cabin](https://hackcabin.com) for a production example of which the
16 16
 
17 17
 ## Principia
18 18
 
19
-Features are great, especially when they're there for a reason. Let the following principles serve as a guide for change in the theme.
19
+The following principles serve as a guide for change in the theme.
20 20
 
21 21
 Principle | Description
22 22
 ---|---
23
-Deceptive Simplicity | After Dark is [just a theme](https://themes.gohugo.io/after-dark/), making it a suitable starting point for beginners. Peel back the layers and discover functionality complex enough to level-up even seasoned programmers.
24
-Privacy Focused | Your data is your property. After Dark regards it as private and will make every attempt possible to help you safeguard it from unexpected leakage or use without your knowledge or express consent. Both for you and for your end-users.
25
-Performance Optimized | Page content, favicon, required scripts and styles load in a single request on all pages. Ancillary resources are then loaded asynchronously in an unobtrusive manner, resulting in a ~1 second initial page load over 2G when edge caching.
26
-Inclusive Design | After Dark is designed to function optimally on mobile, tablet, desktop as well as terminal browsers such as [elinks]. This design approach typically results in reasonable accessibility and will help reduce the need for site maintenance over time.
27
-Semantic Versioning | Predictable changes help you stay up-to-date with what's new. After Dark strives to use [Semantic Versioning](https://semver.org/) and keeps a [human-readable log](https://keepachangelog.com/) of all changes.
28
-Scalable to the Core | After Dark is capable of generating ~1000 pages per second and will operate reasonably quickly even when run on constrained hardware thanks to its only hard software dependency: [Hugo](https://gohugo.io/).
23
+Deceptive Simplicity | After Dark is [just a theme](https://themes.gohugo.io/after-dark/), making it a suitable starting point for beginners. Start peeling back the layers and discover advanced functionality designed to make even complex tasks look easy.
24
+Privacy Conscious | Your data is your property. After Dark regards it as private and will take reasonable steps to help you safeguard it. Both for you and for your end-users, often without the need for special knowledge or additional set-up.
25
+Mobile Friendly | Page content, favicon, required scripts and styles load in a single request on all pages. Ancillary resources are then loaded asynchronously in an unobtrusive manner, resulting in a ~1 second initial page load over 2G when edge caching.
26
+Inclusive Design | After Dark is designed to function optimally on mobile, tablet, desktop as well as terminal browsers. This approach typically results in better-than-average accessibility and will help reduce the amount of site maintenance required over time.
27
+Semantic Versioning | Predictable changes help you stay up-to-date with what's new and help make informed decisions on when to update, if at all. After Dark uses [Semantic Versioning](https://semver.org/) and keeps a [human-readable log](https://keepachangelog.com/) of all changes.
28
+Scalable Core | After Dark is capable of generating thousands of pages per second and will operate reasonably well even on constrained hardware thanks to [Hugo](https://gohugo.io/), making it a suitable starting point for everything from the casual blog to a full-blown data aggregator.
29 29
 
30 30
 ## Features
31 31
 
32
-The following table summarizes various theme features considered important enough to differentiate After Dark from other Hugo themes.
32
+The following table summarizes key features which differentiate After Dark from other Hugo themes.
33 33
 
34 34
 Feature | Summary
35 35
 --------|--------
36
-[Module System](#module-system) | Extend After Dark with prebuilt modules to add additional functionality to your site.
37
-[Quick Installer](#getting-started) | No more copying config from a `README` file. No `git` installation necessary. After Dark provides a cross-platform quick installer. One command will install, configure, run and preview the theme so you can focus on the interesting stuff.
38
-[Lazy Loading](#lazy-loading) | Lazily load your images, iFrames and script embeds. After Dark ships with [lazysizes](https://github.com/aFarkas/lazysizes), a zero-configuration JavaScript library with LQIP support, responsive images and more.
39
-[BPG Image Support](#bpg-image-support) | Improve image fidelity and decrease size. Automatically [BPG Image](https://bellard.org/bpg/) support via polyfill.
36
+[Quick Installer](#getting-started) | After Dark provides a cross-platform quick installer. One command is all you need to start creating a website with Hugo and After Dark.
37
+[Module System](#module-system) | Add additional functionality to your site using [Hugo Theme Components](https://gohugo.io/themes/theme-components/). After Dark includes a module system and a number of custom-built modules specifically designed to enhance your site.
38
+[Lazy Loading](#lazy-loading) | Decrease page load time and improve user experience on slower connections. After Dark includes [lazysizes](https://github.com/aFarkas/lazysizes), a zero-configuration JavaScript library, for frictionless lazy-loading of images, scripts, iFrames and more.
40 39
 [Social Engagement](#social-engagement) | After Dark provides automatic and configurable [Open Graph](http://ogp.me/) support, Twitter Cards and Telegram Instant View template to make social shares pop like 37 pieces of flair.
41 40
 [Search Optimization](#search-optimization) | Using [Schema Structured Data](https://moz.com/learn/seo/schema-structured-data) and meta tags, After Dark gives crawlers rich data about the site structure and content. No configuration required.
42 41
 [Post Images](#post-images) | Increase visual appeal of posts. After Dark enables configuration-driven post images which are lazy-loaded, responsive and automatically cropped for a consistent look-and-feel across your site.
@@ -61,7 +60,7 @@ First [Install Hugo](https://gohugo.io/getting-started/installing) and, optional
61 60
 brew install hugo elinks
62 61
 ```
63 62
 
64
-Then run the install script located in `bin/install`, or just paste this into a terminal and press <kbd>Enter</kbd>:
63
+Then run the cross-platform install script located in `bin/install`, or just paste this into a terminal and press <kbd>Enter</kbd>:
65 64
 
66 65
 ```shell
67 66
 curl -s https://git.habd.as/comfusion/after-dark/raw/branch/master/bin/install | bash
@@ -73,7 +72,7 @@ Installation should complete in a matter of seconds.
73 72
 
74 73
 ### Module System
75 74
 
76
-After Dark uses Hugo [Theme Components](https://gohugo.io/themes/theme-components/) to provide optional add-on modules. Each module is packaged as an NPM module for convenience. A summary of available modules can be found in the following table.
75
+After Dark uses Hugo [Theme Components](https://gohugo.io/themes/theme-components/) to provide optional add-on modules. Each module is packaged using NPM for convenience. A summary of available modules can be found in the following table. Got an idea for a new module? Drop into the [Telegram chatroom][1] and let it be known.
77 76
 
78 77
 Module Name | Latest Version | Description
79 78
 ---|---|---
@@ -139,21 +138,6 @@ After Dark includes a _Shortcode_ taking advantage of this feature, enabling you
139 138
 
140 139
 Additional information and examples, including how to set-up and use LQIP (Low-Quality Image Placeholders), are available on the [lazysizes] repository on GitHub.
141 140
 
142
-### BPG Image Support
143
-
144
-The BPG image format provides [high-fidelity images](http://xooyoozoo.github.io/yolo-octo-bugfixes/#vintage-car&jpg=s&bpg=s) which look more like PNGs but loads as fast as a JPG. From a compression standpoint, BPG really shines when handling animations. With support for alpha transparency and given its compression, BPG [literally steamrolls](https://bellard.org/bpg/animation.html) the GIF format of yesteryear.
145
-
146
-**Why haven't I heard of BPG?** You have now, and you'll learn about all kinds of cool stuff like this by keeping your eye on [Perf.Rocks](http://perf.rocks/). Please help push BPG forward by encouraging browser makers to improve [current support levels](http://caniuse.com/#search=bpg).
147
-
148
-Use BPG just like any other image with the `img` element with a `.bpg` image file extension on any [encoded image](https://webencoder.libbpg.org/). After Dark will asynchronously download a BPG polyfill and render the image in a `canvas` element.
149
-
150
-BPG image support is enabled by default in After Dark. To disable support for BPG images add the following to your site configuration:
151
-
152
-```toml
153
-[params.seo]
154
-  disable_bpg = true # Disable BPG image support
155
-```
156
-
157 141
 ### Related Content
158 142
 
159 143
 Promote more of your content to your site visitors. By offering your readers more content that's relevant to them you can increase your site's page views, the time spent on your site and reader loyalty.
@@ -619,6 +603,7 @@ This work is free. You can redistribute it and/or modify it under the
619 603
 terms of the Do What The Fuck You Want To Public License, Version 2,
620 604
 as published by Sam Hocevar. See the COPYING file for more details.
621 605
 
606
+[1]: https://t.me/joinchat/Iw_6FEhmKL9sPUAukX9jzg
622 607
 [lazysizes]: https://github.com/aFarkas/lazysizes
623 608
 [elinks]: http://elinks.or.cz/
624 609
 [Fractal Forest]: https://git.habd.as/comfusion/fractal-forest

Loading…
Cancel
Save