Add an FAQ section (Fixes #12)

diff --git a/README.md b/README.md
index 24700623668d776eefb206146de2e5245475413f..8abd3640a2416398888055291afdc73a9031d09e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,6 +4,23 @@ zs is an extremely minimal static site generator written in Go.
 
 [![Build Status](https://ci.mills.io/api/badges/prologic/zs/status.svg)](https://ci.mills.io/prologic/zs)
 
+Table of Contents:
+
+<!-- toc -->
+- [zs - Zen Static site generator](#zs---zen-static-site-generator)
+    * [Quick Start](#quick-start)
+    * [Features](#features)
+    * [Installation](#installation)
+    * [Ideology](#ideology)
+    * [Extensions](#extensions)
+        * [Extension: Include](#extension-include)
+        * [Extension: RSS](#extension-rss)
+    * [Hooks](#hooks)
+    * [Command line usage](#command-line-usage)
+    * [License](#license)
+
+<!-- tocstop -->
+
 ## Quick Start
 
 ```console
@@ -188,6 +205,44 @@ rm -rf "$ZS_OUTDIR/css/screen.css"
 header of a given markdown file, or the values of certain variables (even if
 it's an empty string).
 
+For full usage see `zs --help`:
+
+```console
+$ zs --help
+zs is an extremely minimal static site generator written in Go.
+
+  - Keep your texts in markdown, or HTML format right in the main directory of your blog/site.
+  - Keep all service files (extensions, layout pages, deployment scripts etc) in the .zs subdirectory.
+  - Define variables in the header of the content files using YAML front matter:
+  - Use placeholders for variables and plugins in your markdown or html files, e.g. {{ title }} or {{ command arg1 arg2 }}.
+  - Write extensions in any language you like and put them into the .zs sub-directory.
+  - Everything the extensions prints to stdout becomes the value of the placeholder.
+
+Usage:
+  zs [command]
+
+Available Commands:
+  build       Builds the whole site or a single file
+  completion  Generate the autocompletion script for the specified shell
+  help        Help about any command
+  serve       Serves the site and rebuilds automatically
+  var         Display variables for the specified file
+  watch       Watches for file changes and rebuilds modified files
+
+Flags:
+  -d, --debug     Enable debug logging
+  -h, --help      help for zs
+  -v, --version   version for zs
+
+Use "zs [command] --help" for more information about a command.
+```
+
+## Frequently Asked Questions
+
+### How do I link to other pages?
+
+Easy! Just write a normal HTML link using an `<a href="/other.html">title</a>` tag or a Markdown link using the normal `[title](/other.html)` syntax.
+
 ## License
 
-`zs` is licensed under the terms of the [MIT License](/LICENSE) and was orignally forked from [zserge/zs](https://github.com/zserge/zs) also licensed under the terms of the [MIT License](/LICENSE.old).
\ No newline at end of file
+`zs` is licensed under the terms of the [MIT License](/LICENSE) and was originally forked from [zserge/zs](https://github.com/zserge/zs) also licensed under the terms of the [MIT License](/LICENSE.old).
\ No newline at end of file

diff --git a/go.mod b/go.mod
index 88860df8a31d050792fbd7bfa5fbf19324bd7497..ef558d1f19189790a3eec87d2091700deab418ab 100644 (file)
--- a/go.mod
+++ b/go.mod
@@ -6,7 +6,6 @@ require (
        github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06
        github.com/sirupsen/logrus v1.9.0
        github.com/spf13/cobra v1.6.1
-       github.com/stretchr/testify v1.8.1
        github.com/yuin/goldmark v1.5.4
        go.mills.io/static v0.0.0-20230316074605-51908d346ffc
        golang.org/x/sync v0.1.0
@@ -16,14 +15,12 @@ require (
 require (
        github.com/NYTimes/gziphandler v1.1.1 // indirect
        github.com/cyphar/filepath-securejoin v0.2.3 // indirect
-       github.com/davecgh/go-spew v1.1.1 // indirect
        github.com/inconshreveable/mousetrap v1.1.0 // indirect
        github.com/julienschmidt/httprouter v1.3.0 // indirect
        github.com/kr/pretty v0.3.0 // indirect
-       github.com/pmezard/go-difflib v1.0.0 // indirect
        github.com/spf13/pflag v1.0.5 // indirect
+       github.com/stretchr/testify v1.8.1 // indirect
        github.com/unrolled/logger v0.0.0-20201216141554-31a3694fe979 // indirect
        golang.org/x/sys v0.6.0 // indirect
        gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
-       gopkg.in/yaml.v3 v3.0.1 // indirect
 )