summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBoluwatife Victor <95125924+BirdboyBolu@users.noreply.github.com>2023-02-24 03:22:56 +0100
committerGitHub <noreply@github.com>2023-02-23 18:22:56 -0800
commitb473280eac576705bc39b8151d27a1e05040d0e8 (patch)
tree2efb654962dff76a9207f6861d5cb5315b7a2c1d
parent95ff3b8e628ba483de345b838de7c0052b2f3b02 (diff)
downloadpelican-b473280eac576705bc39b8151d27a1e05040d0e8.tar.gz
Add better description of what Pelican does to README (#3102)
Co-authored-by: Justin Mayer <entroP@gmail.com>
-rw-r--r--README.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 1d875772..b8cf9371 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