diff --git a/README.md b/README.md index 1f62287..4cf2528 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Django Smart Selects -[![Jazzband](https://jazzband.co/static/img/badge.svg)](https://jazzband.co/) [![Build Status](https://travis-ci.org/jazzband/django-smart-selects.svg?branch=master)](https://travis-ci.org/jazzband/django-smart-selects) [![Coverage Status](https://coveralls.io/repos/github/jazzband/django-smart-selects/badge.svg?branch=master)](https://coveralls.io/github/jazzband/django-smart-selects?branch=master) +[![Jazzband](https://jazzband.co/static/img/badge.svg)](https://jazzband.co/) [![Build Status](https://travis-ci.org/jazzband/django-smart-selects.svg?branch=master)](https://travis-ci.org/jazzband/django-smart-selects) [![Coverage Status](https://coveralls.io/repos/github/jazzband/django-smart-selects/badge.svg?branch=master)](https://coveralls.io/github/jazzband/django-smart-selects?branch=master) [![PyPI](https://img.shields.io/pypi/v/django-smart-selects.svg)](https://pypi.org/project/django-smart-selects/) This package allows you to quickly filter or group "chained" models by adding a custom foreign key or many to many field to your models. This will use an AJAX query to load only the applicable chained objects. diff --git a/docs/installation.md b/docs/installation.md index 3e9d2fd..83a1c1e 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,7 +1,13 @@ ## Installation -1. Add `smart_selects` to your `INSTALLED_APPS` -2. Add the `smart_selects` urls into your project's `urls.py`. This is needed for the `Chained Selects` and `Chained ManyToMany Selects`. For example: +1. Install `django-smart-selects` using a tool like `pip`: + + ```console + $ pip install django-smart-selects + ``` + +2. Add `smart_selects` to your `INSTALLED_APPS` +3. Add the `smart_selects` urls into your project's `urls.py`. This is needed for the `Chained Selects` and `Chained ManyToMany Selects`. For example: ```python urlpatterns = patterns('', @@ -10,4 +16,4 @@ ) ``` -3. You will also need to include jQuery in every page that includes a field from `smart_selects`, or set `JQUERY_URL = True` in your project's `settings.py`. +4. You will also need to include jQuery in every page that includes a field from `smart_selects`, or set `JQUERY_URL = True` in your project's `settings.py`.