Skip to content
This repository has been archived by the owner on Aug 1, 2020. It is now read-only.

Commit

Permalink
Updating the documentation to include instructions to add the app to …
Browse files Browse the repository at this point in the history
…INSTALLED_APPS
  • Loading branch information
Leon Sandøy committed Jan 14, 2019
1 parent 7b1f681 commit 6303fc5
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,19 @@ of adding support for Django 2.0+, as well as for components found in the bulma-

## Installation

You can install it from [PyPI](https://pypi.org/project/django-crispy-bulma/) with `pip install django-crispy-bulma`
You can install `django-crispy-bulma` from [PyPI](https://pypi.org/project/django-crispy-bulma/) by running `pip install django-crispy-bulma`. Make sure you also have `django-crispy-forms` installed, as it will not work without it. In order to activate it, you'll need to modify your projects `settings.py` file.

First make sure you have `django-crispy-forms` installed, as this will not work without it.
First, add `django-crispy-bulma` to your `INSTALLED_APPS`:

In order to activate it, you should add the following to your project `settings.py` file:
```python
INSTALLED_APPS = [
'crispy_forms',
'django_crispy_bulma',
# ...
]
```

Next, add the following to the bottom of the file in order to configure `crispy_forms` to use the **bulma** template pack:
```python
CRISPY_ALLOWED_TEMPLATE_PACKS = (
"bootstrap",
Expand All @@ -27,6 +35,7 @@ CRISPY_ALLOWED_TEMPLATE_PACKS = (
CRISPY_TEMPLATE_PACK = "bulma"
```

You may also need to use Layout objects or form objects from `django_crispy_bulma` in order to build certain objects, like the UploadField. See the documentation below for specifics on objects like these.

UploadField
-----------
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setup(
name='django-crispy-bulma',
version='0.1.0',
version='0.1.1',
description='Django application to add \'django-crispy-forms\' layout objects for Bulma.io',
long_description=open('README.md').read(),
long_description_content_type="text/markdown",
Expand Down

0 comments on commit 6303fc5

Please sign in to comment.