README rewrite (#4372)

.github/wagtail.svg

@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 18.1.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 342.5 126.2" width="343" height="126" enable-background="new 0 0 342.5 126.2" xml:space="preserve">
+<g>
+	<g>
+		<g>
+			<g>
+				<path fill="#FFFFFF" d="M84,1.9l0,5.7c0,0-10.2-3.8-16.8,3.1c-4.8,5-5.2,10.6-3,18.1c21.6,0,25,12.1,25,12.1L87,27l6.8-8.3l0,0
+					C93.8,8.9,85.7,2.4,84,1.9z"/>
+			</g>
+			<g>
+				<path fill="#FFFFFF" d="M87.6,43.6"/>
+			</g>
+			<g>
+				<circle cx="85.9" cy="15.9" r="2.6"/>
+			</g>
+			<g>
+				<g>
+					<path d="M89.2,40.9c0,0-3.3-16.6-24.9-12.1c-2.2-7.5-1.8-13,3-18.1C73.8,3.8,84,7.6,84,7.6l0-5.7C80.4,0.3,77,0,73.2,0
+						C59.3,0,51.6,10.4,48.3,17.4L9.2,89.3l11-2.1L0,126.2l14.1-2.5L24.9,93C55.5,93,94.7,82,89.2,40.9z"/>
+				</g>
+			</g>
+			<g>
+				<polygon points="102.4,27 93.8,18.7 87,27 				"/>
+			</g>
+			<g>
+				<path fill="#FFFFFF" d="M30,84.1c0,0,1-0.2,2.8-0.6c1.8-0.4,4.3-1,7.3-1.8c1.5-0.4,3.1-0.9,4.8-1.5c1.7-0.6,3.5-1.2,5.2-2
+					c1.8-0.7,3.6-1.6,5.4-2.6c1.8-1,3.5-2.1,5.1-3.4c0.4-0.3,0.8-0.6,1.2-1l1.2-1c0.7-0.7,1.5-1.4,2.2-2.2c0.7-0.7,1.3-1.5,1.9-2.3
+					c0.3-0.4,0.6-0.8,0.9-1.2l0.4-0.6l0.4-0.6c0.2-0.4,0.5-0.8,0.7-1.2c0.2-0.4,0.4-0.8,0.7-1.2c0.1-0.2,0.2-0.4,0.3-0.6
+					c0.1-0.2,0.2-0.4,0.3-0.6c0.2-0.4,0.4-0.8,0.5-1.2c0.3-0.8,0.6-1.6,0.9-2.4c0.2-0.8,0.5-1.6,0.7-2.3c0.2-0.7,0.3-1.5,0.5-2.1
+					c0.1-0.7,0.2-1.3,0.3-2c0.1-0.6,0.2-1.2,0.2-1.7c0.1-0.5,0.1-1,0.2-1.5c0.1-1.8,0.1-2.8,0.1-2.8l1.6,0.1c0,0-0.1,1.1-0.2,2.9
+					c-0.1,0.5-0.1,1-0.2,1.5c-0.1,0.6-0.1,1.2-0.3,1.8c-0.1,0.6-0.3,1.3-0.4,2c-0.2,0.7-0.4,1.4-0.6,2.2c-0.2,0.8-0.5,1.5-0.8,2.4
+					c-0.3,0.8-0.6,1.6-1,2.5c-0.2,0.4-0.4,0.8-0.6,1.2c-0.1,0.2-0.2,0.4-0.3,0.6c-0.1,0.2-0.2,0.4-0.3,0.6c-0.2,0.4-0.5,0.8-0.7,1.3
+					c-0.3,0.4-0.5,0.8-0.8,1.2c-0.1,0.2-0.3,0.4-0.4,0.6l-0.4,0.6c-0.3,0.4-0.6,0.8-0.9,1.2c-0.7,0.8-1.3,1.6-2.1,2.3
+					c-0.7,0.8-1.5,1.4-2.3,2.2l-1.2,1c-0.4,0.3-0.8,0.6-1.3,0.9c-1.7,1.2-3.5,2.3-5.3,3.3c-1.8,0.9-3.7,1.8-5.5,2.5
+					c-1.8,0.7-3.6,1.3-5.3,1.8c-1.7,0.5-3.3,1-4.9,1.3c-3,0.7-5.6,1.3-7.4,1.6C31,83.9,30,84.1,30,84.1z"/>
+			</g>
+		</g>
+	</g>
+	<g>
+		<path fill="#231F20" d="M127,83.9h-8.8l-12.6-36.4h7.9l9,27.5l9-27.5h7.9l9,27.5l9-27.5h7.9L153,83.9h-8.8L135.6,59L127,83.9z"/>
+		<path fill="#231F20" d="M200.1,83.9h-7V79c-3,3.6-7,5.4-12.1,5.4c-3.8,0-6.9-1.1-9.4-3.2c-2.5-2.1-3.7-5-3.7-8.6
+			c0-3.6,1.3-6.3,4-8c2.6-1.8,6.2-2.7,10.7-2.7h9.9v-1.4c0-4.8-2.7-7.3-8.1-7.3c-3.4,0-6.9,1.2-10.5,3.7l-3.4-4.8
+			c4.4-3.5,9.4-5.3,15.1-5.3c4.3,0,7.8,1.1,10.5,3.2c2.7,2.2,4.1,5.6,4.1,10.2V83.9z M192.4,70.3v-3.1h-8.6c-5.5,0-8.3,1.7-8.3,5.2
+			c0,1.8,0.7,3.1,2.1,4.1c1.4,0.9,3.3,1.4,5.7,1.4c2.4,0,4.6-0.7,6.4-2.1C191.5,74.5,192.4,72.7,192.4,70.3z"/>
+		<path fill="#231F20" d="M241.7,47.5v31.7c0,6.4-1.7,11.3-5.2,14.5c-3.5,3.2-8,4.8-13.4,4.8c-5.5,0-10.4-1.7-14.8-5.1l3.6-5.8
+			c3.6,2.7,7.1,4,10.8,4c3.6,0,6.5-0.9,8.6-2.8c2.1-1.9,3.2-4.9,3.2-9v-4.7c-1.1,2.1-2.8,3.9-4.9,5.1c-2.1,1.3-4.5,1.9-7.1,1.9
+			c-4.8,0-8.8-1.7-11.9-5.1c-3.1-3.4-4.7-7.6-4.7-12.6c0-5,1.6-9.2,4.7-12.6c3.1-3.4,7.1-5.1,11.9-5.1c4.8,0,8.7,2,11.7,6v-5.4
+			H241.7z M213.3,64.3c0,3,0.9,5.6,2.8,7.7c1.8,2.2,4.3,3.2,7.5,3.2c3.1,0,5.7-1,7.6-3.1c1.9-2.1,2.9-4.7,2.9-7.8
+			c0-3.1-1-5.8-2.9-7.9c-2-2.2-4.5-3.2-7.6-3.2c-3.1,0-5.6,1.1-7.4,3.4C214.2,58.7,213.3,61.3,213.3,64.3z"/>
+		<path fill="#231F20" d="M260.9,53.6v18.5c0,1.7,0.5,3.1,1.4,4.1c0.9,1,2.2,1.5,3.8,1.5c1.6,0,3.2-0.8,4.7-2.4l3.1,5.4
+			c-2.7,2.4-5.7,3.6-8.9,3.6c-3.3,0-6-1.1-8.3-3.4c-2.3-2.3-3.5-5.3-3.5-9.1V53.6h-4.6v-6.2h4.6V36.1h7.7v11.4h9.6v6.2H260.9z"/>
+		<path fill="#231F20" d="M309.5,83.9h-7V79c-3,3.6-7,5.4-12.1,5.4c-3.8,0-6.9-1.1-9.4-3.2c-2.5-2.1-3.7-5-3.7-8.6
+			c0-3.6,1.3-6.3,4-8c2.6-1.8,6.2-2.7,10.7-2.7h9.9v-1.4c0-4.8-2.7-7.3-8.1-7.3c-3.4,0-6.9,1.2-10.5,3.7l-3.4-4.8
+			c4.4-3.5,9.4-5.3,15.1-5.3c4.3,0,7.8,1.1,10.5,3.2c2.7,2.2,4.1,5.6,4.1,10.2V83.9z M301.8,70.3v-3.1h-8.6c-5.5,0-8.3,1.7-8.3,5.2
+			c0,1.8,0.7,3.1,2.1,4.1c1.4,0.9,3.3,1.4,5.7,1.4c2.4,0,4.6-0.7,6.4-2.1C300.9,74.5,301.8,72.7,301.8,70.3z"/>
+		<path fill="#231F20" d="M319.3,40.2c-1-1-1.4-2.1-1.4-3.4c0-1.3,0.5-2.5,1.4-3.4c1-1,2.1-1.4,3.4-1.4c1.3,0,2.5,0.5,3.4,1.4
+			c1,1,1.4,2.1,1.4,3.4c0,1.3-0.5,2.5-1.4,3.4s-2.1,1.4-3.4,1.4C321.4,41.7,320.3,41.2,319.3,40.2z M326.5,83.9h-7.7V47.5h7.7V83.9z
+			"/>
+		<path fill="#231F20" d="M342.5,83.9h-7.7V33.1h7.7V83.9z"/>
+	</g>
+</g>
+</svg>

MANIFEST.in

@@ -1,4 +1,4 @@
-include LICENSE *.rst *.txt
+include LICENSE *.rst *.txt *.md
 graft wagtail
 prune wagtail/wagtailadmin/static_src
 global-exclude __pycache__

README.md

@@ -0,0 +1,92 @@
+<h1 align="center">
+	<img width="343" src="https://cdn.rawgit.com/wagtail/wagtail/master/.github/wagtail.svg" alt="Wagtail">
+	<br>
+	<br>
+</h1>
+
+Wagtail is an open source content management system built on Django, with a strong community and commercial support. It's focused on user experience, and offers precise control for designers and developers.
+
+![Wagtail screenshot](https://cdn.rawgit.com/wagtail/wagtail/master/.github/wagtail-screenshot-with-browser.png)
+
+### Features
+
+* A fast, attractive interface for authors
+* Complete control over front-end design and structure
+* Scales to millions of pages and thousands of editors
+* Fast out of the box, cache-friendly when you need it
+* Content API for 'headless' sites with de-coupled front-end
+* Runs on a Raspberry Pi or a multi-datacenter cloud platform 
+* StreamField encourages flexible content without compromising structure
+* Powerful, integrated search, using Elasticsearch or PostgreSQL
+* Excellent support for images and embedded content
+* Multi-site and multi-language ready
+* Embraces and extends Django
+
+Find out more at [wagtail.io](https://wagtail.io/).
+
+### Getting started
+
+Wagtail works with Python 3, on any platform.
+
+```
+    pip install wagtail
+    wagtail start mysite
+    cd mysite
+    python manage.py migrate
+    python manage.py createsuperuser
+    python manage.py runserver
+```
+
+For detailed installation and setup docs, see [docs.wagtail.io](http://docs.wagtail.io/).
+
+### Who’s using it?
+
+Wagtail is used by NASA, Google, Oxfam, the NHS, Mozilla, MIT, the Red Cross, Salesforce, NBC, BMW, and the US and UK governments. Add your own Wagtail site to [madewithwagtail.org](http://madewithwagtail.org).
+
+### Documentation
+
+[docs.wagtail.io](http://docs.wagtail.io/) is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap.
+
+### Compatibility
+
+Wagtail supports:
+
+* Django 1.11.x and 2.0
+* Python 3.4, 3.5 and 3.6
+* PostgreSQL, MySQL and SQLite as database backends
+
+Previous versions of Wagtail (1.13 and earlier) additionally supported Python 2.7.
+
+---
+
+### Community Support
+
+There is an active community of Wagtail users and developers responding to questions on [Stack Overflow](http://stackoverflow.com/questions/tagged/wagtail). When posting questions, please read Stack Overflow's advice on [how to ask questions](http://stackoverflow.com/help/how-to-ask) and remember to tag your question "wagtail".
+
+For topics and discussions that do not fit Stack Overflow's question and answer format, we have a [Slack workspace](https://github.com/wagtail/wagtail/wiki/Slack) and a [Wagtail Support mailing list](https://groups.google.com/forum/#!forum/wagtail).
+
+We maintain a curated list of third party packages, articles and other resources at [Awesome Wagtail](https://github.com/springload/awesome-wagtail).
+
+### Commercial Support
+
+Wagtail is sponsored by [Torchbox](https://torchbox.com/). If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com. See also [madewithwagtail.org/developers/](https://madewithwagtail.org/developers/) for expert Wagtail developers around the world.
+
+### Contributing
+
+If you're a Python or Django developer, fork the repo and get stuck in! We run a separate group for developers of Wagtail itself at https://groups.google.com/forum/#!forum/wagtail-developers (please note that this is not for support requests).
+
+You might like to start by reviewing the [contributing guidelines](http://docs.wagtail.io/en/latest/contributing/index.html) and checking issues with the [good first issue](https://github.com/wagtail/wagtail/labels/good%20first%20issue) label.
+
+We also welcome translations for Wagtail's interface. Translation work should be submitted through [Transifex](https://www.transifex.com/projects/p/wagtail/).
+
+### Thanks
+
+We thank [BrowserStack](https://www.browserstack.com/), who provide the project with free access to their live web-based browser testing tool, and automated Selenium cloud testing.
+
+[![Browserstack](https://cdn.rawgit.com/wagtail/wagtail/master/.github/browserstack-logo.svg)](https://www.browserstack.com/)
+
+[![Build Status](https://api.travis-ci.org/wagtail/wagtail.svg?branch=master)](https://travis-ci.org/wagtail/wagtail)
+[![License](https://img.shields.io/badge/license-BSD-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![Version](https://img.shields.io/pypi/v/wagtail.svg)](https://pypi.python.org/pypi/wagtail/) 
+[![Coverage](http://codecov.io/github/wagtail/wagtail/coverage.svg?branch=master)](http://codecov.io/github/wagtail/wagtail?branch=master)
+[![Slack](https://wagtail-slack.now.sh/badge.svg)](https://wagtail-slack.now.sh)

README.rst

@@ -1,91 +0,0 @@
-.. image:: https://api.travis-ci.org/wagtail/wagtail.svg?branch=master
-    :target: https://travis-ci.org/wagtail/wagtail
-.. image:: https://img.shields.io/pypi/l/wagtail.svg
-    :target: https://pypi.python.org/pypi/wagtail/
-.. image:: https://img.shields.io/pypi/v/wagtail.svg
-    :target: https://pypi.python.org/pypi/wagtail/
-.. image:: http://codecov.io/github/wagtail/wagtail/coverage.svg?branch=master
-    :target: http://codecov.io/github/wagtail/wagtail?branch=master
-
-
-Wagtail CMS
-===========
-
-Wagtail is a content management system built on Django. It's focused on user experience,
-and offers precise control for designers and developers.
-
-.. image:: http://i.imgur.com/hSVerKq.jpg
-   :width: 728 px
-
-Features
-~~~~~~~~
-
-* A fast, attractive interface for authors and editors
-* Complete control over design with standard Django templates
-* Configure content types through standard Django models
-* Fast out of the box. Cache-friendly if you need it
-* Tightly integrated search
-* Strong document and image management
-* Wide support for embedded content
-* Straightforward integration with existing Django apps
-* Simple, configurable permissions
-* Workflow support
-* An extensible `form builder <http://docs.wagtail.io/en/latest/reference/contrib/forms/index.html>`_
-* Multi-site and multi-language support
-* Excellent `test coverage <http://codecov.io/github/wagtail/wagtail?branch=master>`_
-
-Find out more at `wagtail.io <http://wagtail.io/>`_.
-
-Getting started
-~~~~~~~~~~~~~~~
-
-.. code-block:: sh
-
-    pip install wagtail
-    wagtail start mysite
-    cd mysite
-    python manage.py migrate
-    python manage.py createsuperuser
-    python manage.py runserver
-
-then sign in at http://127.0.0.1:8000/admin/
-
-For detailed installation and setup docs, see `docs.wagtail.io <http://docs.wagtail.io/>`_.
-
-Who's using it?
-~~~~~~~~~~~~~~~
-`madewithwagtail.org <http://madewithwagtail.org>`_ lists some of the public Wagtail sites we know about; please `add your own <http://madewithwagtail.org/submit/>`_.
-
-Documentation
-~~~~~~~~~~~~~
-`docs.wagtail.io <http://docs.wagtail.io/>`_ is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap.
-
-Community Support
-~~~~~~~~~~~~~~~~~
-There is an active community of Wagtail users and developers responding to questions on `Stack Overflow <http://stackoverflow.com/questions/tagged/wagtail>`_. When posting questions, please read Stack Overflow's advice on `how to ask questions <http://stackoverflow.com/help/how-to-ask>`_ and remember to tag your question with "wagtail".
-
-For topics and discussions that do not fit Stack Overflow's question-and-answer format, there is also a `Wagtail Support mailing list <https://groups.google.com/forum/#!forum/wagtail>`_ and a `Slack workspace <https://github.com/wagtail/wagtail/wiki/Slack>`_.
-
-Commercial Support
-~~~~~~~~~~~~~~~~~~
-Wagtail is sponsored by `Torchbox <https://torchbox.com/>`_. If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com.
-
-Thanks
-~~~~~~
-We thank `BrowserStack <https://www.browserstack.com/>`_, who provide the project with free access to their live web-based browser testing tool, and automated Selenium cloud testing.
-
-.. image:: https://cdn.rawgit.com/wagtail/wagtail/master/.github/browserstack-logo.svg
-    :target: https://www.browserstack.com/
-    :width: 219 px
-
-Compatibility
-~~~~~~~~~~~~~
-Wagtail supports Django 1.11.x and 2.0 on Python 3.4, 3.5 and 3.6. Supported database backends are PostgreSQL, MySQL and SQLite.
-
-Contributing
-~~~~~~~~~~~~
-If you're a Python or Django developer, fork the repo and get stuck in! We run a separate group for developers of Wagtail itself at https://groups.google.com/forum/#!forum/wagtail-developers (please note that this is not for support requests).
-
-You might like to start by reviewing the `contributing guidelines <http://docs.wagtail.io/en/latest/contributing/index.html>`_ and checking issues with the `good first issue <https://github.com/wagtail/wagtail/labels/good%20first%20issue>`_ label.
-
-We also welcome translations for Wagtail's interface. Translation work should be submitted through `Transifex <https://www.transifex.com/projects/p/wagtail/>`_.

setup.py

@@ -67,14 +67,19 @@ documentation_extras = [
 setup(
     name='wagtail',
     version=__version__,
-    description='A Django content management system focused on flexibility and user experience',
+    description='A Django content management system.',
     author='Wagtail core team + contributors',
     author_email='hello@wagtail.io',  # For support queries, please see http://docs.wagtail.io/en/stable/support.html
     url='http://wagtail.io/',
     packages=find_packages(),
     include_package_data=True,
     license='BSD',
-    long_description=open('README.rst').read(),
+    long_description="Wagtail is an open source content management \
+system built on Django, with a strong community and commercial support. \
+It’s focused on user experience, and offers precise control for \
+designers and developers.\n\n\
+For more details, see https://wagtail.io, http://docs.wagtail.io and \
+https://github.com/wagtail/wagtail/.",
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Environment :: Web Environment',