From 7eafaba49a1e59abd7c7cb353e8cf0ed550000e1 Mon Sep 17 00:00:00 2001
From: Bastian Venthur <venthur@debian.org>
Date: Fri, 12 Mar 2021 21:06:54 +0100
Subject: [PATCH] updated readme

---
 README.md | 18 +++++++++++-------
 setup.py  |  2 +-
 2 files changed, 12 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index b2566ae..f383708 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,13 @@
 # blag
 
-blag is a blog-aware, static site generator, written in Python.
+blag is a blog-aware, static site generator, written in [Python][].
 
 blag is named after [the blag of the webcomic xkcd][blagxkcd].
 
+[python]: https://python.org
 [blagxkcd]: https://blog.xkcd.com
 
+
 ## Features
 
 * Write content in [Markdown][]
@@ -13,16 +15,18 @@ blag is named after [the blag of the webcomic xkcd][blagxkcd].
 * Generation of Atom feeds for blog content
 * Fenced code blocks and syntax highlighting using [Pygments][]
 
+blag runs on Linux, Mac and Windows and requires Python >= 3.8
+
 [markdown]: https://daringfireball.net/projects/markdown/
 [jinja2]: https://palletsprojects.com/p/jinja/
 [pygments]: https://pygments.org/
 
-## Installation
+
+## Quickstart
 
 ```bash
-$ pip install blag
+$ pip install blag                  # 1. install blag
+$ blag quickstart                   # 2. create a new site
+$ vim content/hello-world.md        # 3. create some content
+$ blag build                        # 4. build the website
 ```
-
-## Usage
-
-TBD
diff --git a/setup.py b/setup.py
index 781f6f9..12e322b 100644
--- a/setup.py
+++ b/setup.py
@@ -10,7 +10,7 @@ meta['long_description'] = open('./README.md').read()
 setup(
     name='blag',
     version=meta['__VERSION__'],
-    description='simple blog-aware static site generator',
+    description='blog-aware, static site generator',
     long_description=meta['long_description'],
     long_description_content_type='text/markdown',
     keywords='markdown blag blog static site generator cli',