Skip to content

Commit 5f210cb

Browse files
committed
more flexibility again in requirements, and added 1.2.0 to changelog
1 parent 6657a1a commit 5f210cb

File tree

2 files changed

+18
-12
lines changed

2 files changed

+18
-12
lines changed

README.rst

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Django-Experiments is best installed via pip:
2121

2222
pip install django-experiments
2323

24-
This should download django-experiments and any dependencies. If downloading from the repo,
24+
This should download django-experiments and any dependencies. If downloading from the repo,
2525
pip is still the recommended way to install dependencies:
2626

2727
::
@@ -76,7 +76,7 @@ Next, activate the apps by adding them to your INSTALLED_APPS:
7676
'experiments',
7777
]
7878

79-
Include 'django.contrib.humanize' as above if not already included.
79+
Include 'django.contrib.humanize' as above if not already included.
8080

8181
Include the app URLconf in your urls.py file:
8282

@@ -101,7 +101,7 @@ If you want to use the built in retention goals you will need to include the ret
101101
Experiments and Alternatives
102102
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103103

104-
The experiment can be manually created in your Django admin. Adding alternatives must currently be done in template tags or by calling the relevant code, as described below.
104+
The experiment can be manually created in your Django admin. Adding alternatives must currently be done in template tags or by calling the relevant code, as described below.
105105

106106
An experiment allows you to test the effect of various design
107107
alternatives on user interaction. Django-Experiments is designed to work
@@ -205,7 +205,7 @@ settings.*
205205

206206
After creating an experiment either using the Django admin, or through
207207
template tags or code, you must enable the experiment in the Django
208-
admin or manually for it to work.
208+
admin or manually for it to work.
209209

210210

211211
Goals
@@ -222,7 +222,7 @@ Add the goal to our EXPERIMENT_GOALS tuple in setting.py:
222222

223223
EXPERIMENTS_GOALS = ("registration",)
224224

225-
Goals are simple strings that uniquely identify a goal.
225+
Goals are simple strings that uniquely identify a goal.
226226

227227
Our registration successful page will contain the goal template tag:
228228

@@ -233,31 +233,31 @@ Our registration successful page will contain the goal template tag:
233233
This will be fired when the user loads the page. This is not the only way of firing a goal. In total, there are four ways of recording goals:
234234

235235
1. **Django Template Tags** (as above).
236-
236+
237237
::
238-
238+
239239
{% experiment_goal "registration" %}
240240

241241
2. **Server side**, using a python function somewhere in your django views:
242242

243243
::
244-
244+
245245
from experiments.utils import participant
246-
246+
247247
participant(request).goal('registration')
248248

249249
3. **JavaScript onclick**:
250250

251251
::
252-
252+
253253
<button onclick="experiments.goal('registration')">Complete Registration</button>
254254

255255
(Please note, this requires CSRF authentication. Please see the `Django Docs <https://docs.djangoproject.com/en/1.4/ref/contrib/csrf/#ajax>`_)
256256

257257
4. **Cookies**:
258258

259259
::
260-
260+
261261
<span data-experiments-goal="registration">Complete Registration</span>
262262

263263
Multiple goals can be recorded via the cookie using space as a separator.
@@ -340,6 +340,12 @@ See conf.py for other settings
340340

341341
Changelog
342342
---------
343+
1.2.0
344+
~~~~~
345+
- Add support for Django 1.10 (Thanks to @Kobold)
346+
- Make requirements.txt more flexible
347+
- Tox support added for testing on multiple Django Versions (Thanks to @Kobold again!)
348+
343349
1.1.6
344350
~~~~~
345351
- Change to use django-modeldict-yplan as its maintained

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
redis>=2.4.9
22
django>=1.7.0
3-
django-modeldict-yplan==1.5.0
3+
django-modeldict-yplan>=1.5.0
44
jsonfield>=1.0.3
55
mock>=1.0.1
66
tox>=2.3.1

0 commit comments

Comments
 (0)