wagtail/README.rst

.. image:: https://travis-ci.org/torchbox/wagtail.png?branch=master   :target: https://travis-ci.org/torchbox/wagtail

Wagtail CMS
===========

.. image:: http://i.imgur.com/4pbWQ35.png

Wagtail is a Django content management system built originally for the `Royal College of Art <http://www.rca.ac.uk/>`_ and focused on flexibility and user experience. Its features include:

* A fast, attractive editor interface
* Complete control over design with standard Django templates
* Configure content types through standard Django models
* Tightly integrated search (with an `Elasticsearch <http://www.elasticsearch.org/>`_ backend for production)
* Strong document and image management
* Wide support for embedded content
* Simple, configurable permissions
* Support for tree-based content organisation
* Optional preview->submit->approve workflow
* Fast out of the box. `Varnish <https://www.varnish-cache.org/>`_-friendly if you need it
* Tests! But not enough; we're working hard to improve this

Find out more at `wagtail.io <http://wagtail.io/>`_.

Got a question? Ask it on our `Google Group <https://groups.google.com/forum/#!forum/wagtail>`_.

Getting started
~~~~~~~~~~~~~~~
To get you up and running quickly, we've provided a demonstration site with all the configuration in place, at `github.com/torchbox/wagtaildemo <https://github.com/torchbox/wagtaildemo/>`_; see the `README <https://github.com/torchbox/wagtaildemo/blob/master/README.md>`_ for installation instructions. `Serafeim Papastefanos <https://github.com/spapas>`_ has written a `tutorial <http://spapas.github.io/2014/02/13/wagtail-tutorial/>`_ with all the steps to build a simple Wagtail site from scratch.

Contributing
~~~~~~~~~~~~
If you're a Python or Django developer, fork the repo and get stuck in! Send us a useful pull request and we'll post you a `t-shirt <https://twitter.com/WagtailCMS/status/432166799464210432/photo/1>`_. Our immediate priorities are better docs, more tests, internationalisation and localisation.
Update README.rst Reverting fb391aa to see if it fixes the CDN cached 'build unknown' (the original markup was is taken direct from the snippet Travis provides). 2014-02-17 16:47:01 +00:00			`.. image:: https://travis-ci.org/torchbox/wagtail.png?branch=master :target: https://travis-ci.org/torchbox/wagtail`
Shiny (for now ;) Travis Build Passing badge for the README. 2014-02-14 12:50:32 +00:00
change readme to .rst for use on PyPI 2014-02-07 14:35:12 +00:00			`Wagtail CMS`
			`===========`
Update and rename README.rst to README.md 2014-02-07 11:50:51 +00:00
Added RCA screenshot to README 2014-02-14 13:34:01 +00:00			`.. image:: http://i.imgur.com/4pbWQ35.png`

Update README.rst with feature list 2014-02-13 11:41:56 +00:00			Wagtail is a Django content management system built originally for the `Royal College of Art <http://www.rca.ac.uk/>`_ and focused on flexibility and user experience. Its features include:

			`* A fast, attractive editor interface`
			`* Complete control over design with standard Django templates`
			`* Configure content types through standard Django models`
			* Tightly integrated search (with an `Elasticsearch <http://www.elasticsearch.org/>`_ backend for production)
			`* Strong document and image management`
			`* Wide support for embedded content`
Tree support in feature list. 2014-02-13 12:08:43 +00:00			`* Simple, configurable permissions`
			`* Support for tree-based content organisation`
Update README.rst with feature list 2014-02-13 11:41:56 +00:00			`* Optional preview->submit->approve workflow`
			* Fast out of the box. `Varnish <https://www.varnish-cache.org/>`_-friendly if you need it
			`* Tests! But not enough; we're working hard to improve this`

Update README.rst 2014-02-13 16:56:38 +00:00			Find out more at `wagtail.io <http://wagtail.io/>`_.

			Got a question? Ask it on our `Google Group <https://groups.google.com/forum/#!forum/wagtail>`_.
Update and rename README.rst to README.md 2014-02-07 11:50:51 +00:00
Update README.rst link to wagtaildemo and make t-shirt promise. 2014-02-12 18:21:16 +00:00			`Getting started`
			`~~~~~~~~~~~~~~~`
Change tutorial link to Serafeim's blog 2014-02-13 22:54:11 +00:00			To get you up and running quickly, we've provided a demonstration site with all the configuration in place, at `github.com/torchbox/wagtaildemo <https://github.com/torchbox/wagtaildemo/>`_; see the `README <https://github.com/torchbox/wagtaildemo/blob/master/README.md>`_ for installation instructions. `Serafeim Papastefanos <https://github.com/spapas>`_ has written a `tutorial <http://spapas.github.io/2014/02/13/wagtail-tutorial/>`_ with all the steps to build a simple Wagtail site from scratch.
Update README.rst link to wagtaildemo and make t-shirt promise. 2014-02-12 18:21:16 +00:00
			`Contributing`
			`~~~~~~~~~~~~`
Update README.rst with feature list 2014-02-13 11:41:56 +00:00			If you're a Python or Django developer, fork the repo and get stuck in! Send us a useful pull request and we'll post you a `t-shirt <https://twitter.com/WagtailCMS/status/432166799464210432/photo/1>`_. Our immediate priorities are better docs, more tests, internationalisation and localisation.