Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/mtford90/silky
Browse files Browse the repository at this point in the history
  • Loading branch information
mtford90 committed Jun 7, 2014
2 parents 15f7b79 + e33230c commit b0c4349
Showing 1 changed file with 13 additions and 37 deletions.
50 changes: 13 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -247,26 +245,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 django-silk-<version>.tar.gz
```

Once downloaded, run:
From master:

```bash
pip install dist/django-silk-<version>.tar.gz
pip install -e git+https://github.com/mtford90/silk.git#egg=silk
```

### Configure

Then configure Silk in `settings.py`:

```python
Expand Down Expand Up @@ -296,30 +296,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:
Expand Down

0 comments on commit b0c4349

Please sign in to comment.