From f671969eb96747357a2d7c2b09cbed7007eaeaea Mon Sep 17 00:00:00 2001 From: adi Date: Thu, 18 Aug 2016 22:03:44 +0200 Subject: [PATCH] README updates --- README.md | 27 +++++++++++---------------- setup.py | 27 ++++++++++++++++++++++++--- 2 files changed, 35 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 54fbb83..d00da6f 100755 --- a/README.md +++ b/README.md @@ -7,30 +7,25 @@ [![Django Versions](https://img.shields.io/badge/Django-1.8,%201.9,%201.10-green.svg)](https://www.djangoproject.com/) [![License](https://img.shields.io/pypi/l/django-markdownx.svg)](https://pypi.python.org/pypi/django-markdownx/) -**django-markdownx** is a Markdown editor built for Django. +#### Key features -**Key features**: - -* raw editing, -* live preview, -* drag&drop image uploads (stored locally in `MEDIA` folder), -* customizable image insertion tag, -* image filtering using content types and max file size, -* image manipulations (compression, size, cropping), -* pre- & post- text altering, -* easy template customization for layout purposes, +* raw editing +* live preview +* drag&drop image uploads (stored locally in `MEDIA` folder) +* customizable image insertion tag +* image filtering using content types and max file size +* image manipulations (compression, size, cropping, upscaling) +* pre-&post- text altering +* easy template customization for layout purposes +* multiple editors on one page * Django Admin support -**Preview**: +#### Preview ![Preview](https://github.com/adi-/django-markdownx/blob/master/django-markdownx-preview.gif?raw=true "Preview") *(using Bootstrap for layout and styling)* -Template is highly customizable, so you can easily use i.e. Bootstrap to layout editor pane and preview pane side by side. Using multiple editors on one page is supported. - -*Side note: Just to keep it simple, all UI editing controls are unwelcome – this is Markdown editor not a web MS Word imitation.* - # Menu diff --git a/setup.py b/setup.py index 7f089d4..c9791a8 100755 --- a/setup.py +++ b/setup.py @@ -13,10 +13,31 @@ setup( version='1.6.2', packages=find_packages(), include_package_data=True, - description='Django Markdownx is a Markdown editor built for Django. It enables raw editing, live preview and image uploads (stored in `MEDIA` folder) with drag&drop functionality and auto tag insertion.', - long_description='See full readme: https://github.com/adi-/django-markdownx', + description='django-markdownx is a Markdown editor built for Django.', + long_description='''Key features +------------ + +* raw editing +* live preview +* drag&drop image uploads (stored locally in `MEDIA` folder) +* customizable image insertion tag +* image filtering using content types and max file size +* image manipulations (compression, size, cropping, upscaling) +* pre-&post- text altering +* easy template customization for layout purposes +* multiple editors on one page +* Django Admin support + +Preview +------- + +.. image:: https://github.com/adi-/django-markdownx/raw/master/django-markdownx-preview.gif?raw=true + :target: https://github.com/adi-/django-markdownx + :alt: django-markdownx preview + +*(using Bootstrap for layout and styling)* +''', url='https://github.com/adi-/django-markdownx', - download_url='https://github.com/adi-/django-markdownx/archive/master.zip', license='BSD', classifiers=[ 'Development Status :: 5 - Production/Stable',