From 6e58d0e2ea59b3fee3fabeb714ad0bca7b7283c3 Mon Sep 17 00:00:00 2001 From: Michael Ford Date: Sat, 7 Jun 2014 13:35:07 +0100 Subject: [PATCH 1/3] Update README.md --- README.md | 44 +++++++++++--------------------------------- 1 file changed, 11 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index cc6a2105..902c1070 100644 --- a/README.md +++ b/README.md @@ -247,26 +247,28 @@ Both are intended for use in replaying the request. The curl command can be used ## Installation -### Existing Release +### Download -#### Pip +Via pip into a virtualenv: -Silk is on PyPi. Install via pip (into your virtualenv) as follows: - -``` +```bash pip install django-silk ``` -#### Github Tag +Via [github tags](https://github.com/mtford90/silk/releases): -Releases of Silk are available on [github](https://github.com/mtford90/silk/releases). +```bash +pip install dist/django-silk-.tar.gz +``` -Once downloaded, run: +From master: ```bash -pip install dist/django-silk-.tar.gz +pip install -e git+https://github.com/mtford90/silk.git#egg=silk ``` +### Configure + Then configure Silk in `settings.py`: ```python @@ -296,30 +298,6 @@ python manage.py syncdb Silk will automatically begin interception of requests and you can proceed to add profiling if required. The UI can be reached at `/silk/` -### Master - -First download the [source](https://github.com/mtford90/silky/archive/master.zip), unzip and -navigate via the terminal to the source directory. Then run: - -```bash -python package.py mas -``` - -You can either install via pip: - -```bash -pip install dist/django-silk-mas.tar.gz -``` - -or run setup.py: - -```bash -tar -xvf dist/django-silk-mas.tar.gz -python dist/django-silk-mas/setup.py -``` - -You can then follow the steps in 'Existing Release' to include Silk in your Django project. - ## Roadmap I would eventually like to use this in a production environment. There are a number of things preventing that right now: From 44e7115e6391da94a9e076103f01db9b286cd9b9 Mon Sep 17 00:00:00 2001 From: Michael Ford Date: Sat, 7 Jun 2014 13:36:34 +0100 Subject: [PATCH 2/3] Update README.md --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 902c1070..274d4f06 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,8 @@ Documentation is below and a live demo is available at [http://mtford.co.uk/silk * [Dynamic Profiling](#dynamic-profiling) * [Code Generation](#code-generation) * [Installation](#installation) - * [Existing Release](#existing-release) - * [Pip](#Pip) - * [Github Tag](#Github Tag) - * [Master](#master) + * [Download](#download) + * [Configure](#configure) * [Roadmap](#roadmap) ## Requirements From e33230c325d85792f0bdf7878597fe9e8447eb9e Mon Sep 17 00:00:00 2001 From: Michael Ford Date: Sat, 7 Jun 2014 13:37:41 +0100 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 274d4f06..89077e66 100644 --- a/README.md +++ b/README.md @@ -256,7 +256,7 @@ pip install django-silk Via [github tags](https://github.com/mtford90/silk/releases): ```bash -pip install dist/django-silk-.tar.gz +pip install django-silk-.tar.gz ``` From master: