aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2018-08-05 03:19:15 +0200
committerTeddy Wing2018-08-05 03:19:15 +0200
commit34ac3ec06080de340f6454be10075ad8983ba9bc (patch)
tree03816dbca79efbd83b3dfddad4e9b1c4cb0a569b
parentaed995aa75223181d72a9ebfb9a57a7eac397276 (diff)
downloadLegibility-34ac3ec06080de340f6454be10075ad8983ba9bc.tar.bz2
README: Add usage example
Add an example to show how the extension works.
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index e5a9cd3..7a64fc0 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,20 @@ experience.
## Usage
+Let's say we want to modify the font of an article on `www.example.com`. Add an
+`www.example.com.css` file in the extension's `css/` directory:
+
+``` css
+/* legibility/css/www.example.com.css */
+article {
+ font: 18px/1.7em Georgia !important;
+}
+```
+
+Upon reloading the page, the custom stylesheet should now be applied.
+
+Stylesheets must use a filename matching the website's domain (including
+subdomains), and terminated by a `.css` extension.
## Install