From 542a4a7a27793dbff6cfe8fba9fa6c61b7a0e9f7 Mon Sep 17 00:00:00 2001 From: Boluwatife Victor <95125924+BirdboyBolu@users.noreply.github.com> Date: Fri, 24 Feb 2023 03:22:56 +0100 Subject: [PATCH] Add better description of what Pelican does to README (#3102) Co-authored-by: Justin Mayer --- README.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 1d875772d..b8cf9371d 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,13 @@ Pelican |build-status| |pypi-version| |repology| ================================================ -Pelican is a static site generator, written in Python_. +Pelican is a static site generator, written in Python_, that allows you to create +web sites by composing text files in formats such as Markdown, reStructuredText, and HTML. + +With Pelican, you can create web sites without worrying about databases or server-side programming. +Pelican generates static sites that can be served via any web server or hosting service. + +You can perform the following functions with Pelican: * Compose content in Markdown_ or reStructuredText_ using your editor of choice * Simple command-line tool (re)generates HTML, CSS, and JS from your source content