Skip to content

Commit

Permalink
README tweaks
Browse files Browse the repository at this point in the history
minor style changes, removal of segments adapter section.
  • Loading branch information
tomdyson authored and mvantellingen committed May 31, 2017
1 parent 699d24b commit 531ae6d
Showing 1 changed file with 9 additions and 23 deletions.
32 changes: 9 additions & 23 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,10 @@

.. end-no-pypi
Wagtail personalisation
Wagtail Personalisation
=======================

Wagtail personalisation enables simple content personalisation through
segmentation for the `Wagtail CMS`_.
Wagtail Personalisation is a fully-featured personalisation module for `Wagtail CMS`_. It enables editors to create customised pages - or parts of pages - based on segments whose rules are configured directly in the admin interface.

.. _Wagtail CMS: http://wagtail.io/

Expand All @@ -33,6 +32,8 @@ segmentation for the `Wagtail CMS`_.

Instructions
------------
Wagtail Personalisation requires Wagtail 1.10 and Django 1.11.

To install the package with pip::

pip install wagtail-personalisation
Expand All @@ -50,29 +51,14 @@ Next, include the ``wagtail_personalisation`` and
]
Make sure that ``django.contrib.sessions.middleware.SessionMiddleware`` has
been added in first, this is a prerequisite for this project.


Changing segments adapter
-------------------------
To change the segments adapter, first make a new one based on the
``BaseSegmentsAdapter``

.. code-block:: python
class YourSegmentsAdapter(BaseSegmentsAdapter):
# Add your own logic here
Add the ``PERSONALISATION_SEGMENTS_ADAPTER`` setting to your settings.py and
choose your own adapter.

been added in first.

Sandbox
-------

To quickly experiment with the package you can use the sandbox provided in
the git repository. To install this you will need to create and activate a
virtualenv and then run ``make sandbox``. This will start a fresh wagtail
install with the personalisation module enabled on http://localhost:8000. The
To experiment with the package you can use the sandbox provided in
this repository. To install this you will need to create and activate a
virtualenv and then run ``make sandbox``. This will start a fresh Wagtail
install, with the personalisation module enabled, on http://localhost:8000. The
superuser credentials are ``superuser@example.com`` with the password
``testing``.

0 comments on commit 531ae6d

Please sign in to comment.