aboutsummaryrefslogtreecommitdiff
path: root/_doc/example/index.adoc
diff options
context:
space:
mode:
Diffstat (limited to '_doc/example/index.adoc')
-rw-r--r--_doc/example/index.adoc24
1 files changed, 24 insertions, 0 deletions
diff --git a/_doc/example/index.adoc b/_doc/example/index.adoc
new file mode 100644
index 0000000..e76bfa0
--- /dev/null
+++ b/_doc/example/index.adoc
@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+// SPDX-FileCopyrightText: 2020 Shulhan <ms@kilabit.info>
+
+= Welcome to ciigo
+Shulhan <ms@kilabit.info>
+25 September 2019
+:sectanchors:
+:sectlinks:
+:toc:
+
+`ciigo` is a library and a program to write static web server with embedded
+files using
+https://asciidoctor.org/docs/what-is-asciidoc/[AsciiDoc^]
+markup format.
+
+== ciigo as library
+
+For an up to date documentation of how to use the library see the
+https://git.sr.ht/~shulhan/ciigo[repository page^].
+
+== ciigo as CLI
+
+`ciigo` as CLI can convert, generate, and/or serve a directory that contains
+markup files, as HTML files.