From 866c4c7c84bdc5c1550cdd80470df6acd5df262a Mon Sep 17 00:00:00 2001 From: L3D Date: Mon, 23 Aug 2021 22:51:58 +0200 Subject: [PATCH] update project README --- README.md | 10 +++++++--- setup.py | 2 +- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6c766a8..75f6f80 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ lektor image resize plugin ============================ +[![PyPI version](https://badge.fury.io/py/lektor-image-resize.svg)](https://badge.fury.io/py/lektor-image-resize) + [![Downloads](https://pepy.tech/badge/lektor-image-resize)](https://pepy.tech/project/lektor-image-resize) + [![Linting Python package](https://github.com/chaos-bodensee/lektor-image-resize/actions/workflows/pythonpackage.yml/badge.svg)](https://github.com/chaos-bodensee/lektor-image-resize/actions/workflows/pythonpackage.yml) + [![Upload Python Package](https://github.com/chaos-bodensee/lektor-image-resize/actions/workflows/pythonpublish.yml/badge.svg)](https://github.com/chaos-bodensee/lektor-image-resize/actions/workflows/pythonpublish.yml) -This plugin automatically generates thumbnails for any images in your Lektor content. +This plugin automatically generates thumbnails for any images in your [Lektor](https://getlektor.com) content. The difference between this plugin and the lektor [thumbnail](https://www.getlektor.com/docs/api/db/record/thumbnail/) filter is that this plugin is converting all images and you don't need to have any references to the images in your templates. TL;DR: What does this plugin do? @@ -35,9 +39,9 @@ If you have trouble, see the [plugin installation](https://www.getlektor.com/docs/plugins/) section of the Lektor documentation. -Then, create a config file called `configs/thumbnail-generator.ini` and add +Then, create a config file called `configs/image-resize.ini` and add a few sections for images. The section names can be whatever you want, the -final images will be called `imagename-sectionname.ext`. For example, this +final images will be called `imagename-sectionname.jpg`. For example, this config file: ```ini diff --git a/setup.py b/setup.py index 90e5367..ad7a2b6 100644 --- a/setup.py +++ b/setup.py @@ -25,7 +25,7 @@ packages=find_packages(), py_modules=['lektor_image_resize'], url='https://github.com/chaos-bodensee/lektor-image-resize.git', - version='0.1', + version='0.2.0', classifiers=[ 'Framework :: Lektor', 'Environment :: Plugins',