From cfda0a315a0148719b5e6cc90151a08c7045f656 Mon Sep 17 00:00:00 2001 From: Justin Mayer Date: Wed, 3 Jul 2024 22:50:24 +0200 Subject: [PATCH] Clarify installation instructions in README --- .github/FUNDING.yml | 2 +- README.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 7e0d535..c2e5ca8 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,2 +1,2 @@ -custom: https://donate.getpelican.com +github: justinmayer liberapay: pelican diff --git a/README.md b/README.md index f76dab4..a1289af 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![Build Status](https://img.shields.io/github/actions/workflow/status/pelican-plugins/share-post/main.yml?branch=main)](https://github.com/pelican-plugins/share-post/actions) [![PyPI Version](https://img.shields.io/pypi/v/pelican-share-post)](https://pypi.org/project/pelican-share-post/) +[![Downloads](https://img.shields.io/pypi/dm/pelican-share-post)](https://pypi.org/project/pelican-share-post/) ![License](https://img.shields.io/pypi/l/pelican-share-post?color=blue) Share Post is a Pelican plugin that creates share links in articles that allow site visitors to share the current article with others in a privacy-friendly manner. @@ -18,6 +19,8 @@ This plugin can be installed via: python -m pip install pelican-share-post +As long as you have not explicitly added a `PLUGINS` setting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must add `share_post` to your existing `PLUGINS` list. For more information, please see the [How to Use Plugins](https://docs.getpelican.com/en/latest/plugins.html#how-to-use-plugins) documentation. + Usage -----