Skip to content

Commit 0967215

Browse files
Update README
1 parent 6dc7346 commit 0967215

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
[![PyPI status](https://img.shields.io/pypi/status/django-async-include.svg)](https://pypi.python.org/pypi/django-async-include/)
99
[![PyPI download month](https://img.shields.io/pypi/dm/django-async-include.svg)](https://pypi.python.org/pypi/django-async-include/)
1010
[![Maintainability](https://api.codeclimate.com/v1/badges/a795d65d98ec8e261709/maintainability)](https://codeclimate.com/github/diegojromerolopez/django-async-include/maintainability)
11+
[![Test Coverage](https://api.codeclimate.com/v1/badges/a795d65d98ec8e261709/test_coverage)](https://codeclimate.com/github/diegojromerolopez/django-async-include/test_coverage)
1112

1213
Asynchronous inclusion of Django templates
1314

@@ -33,8 +34,7 @@ returns it in the AJAX call.
3334

3435
This application only depends on [pycryptodome](https://github.com/Legrandin/pycryptodome) and [jsonpickle](https://jsonpickle.github.io/).
3536

36-
Of course, you will need [Django](https://www.djangoproject.com/) version 1.10 or newer. I have not tested in lower versions of Django but it
37-
should work fine with versions from 1.8 to 1.9.
37+
Of course, you will need [Django](https://www.djangoproject.com/) version 1.10 or newer.
3838

3939
## jQuery
4040
No jQuery is required as of version 0.6.6.
@@ -43,7 +43,7 @@ No jQuery is required as of version 0.6.6.
4343
[Fontawesome](http://fontawesome.io/) is the the-facto standard of font icons of our time. Include it in your project to see the spinner moving when loading the remote templates.
4444

4545
The easiest way to include it by using a CDN. For example, [bootstrap CDN](https://www.bootstrapcdn.com/fontawesome/)
46-
(not affiliated nor they endorse this project) is one of the most known.
46+
(not affiliated, nor they endorse this project) is one of the most known.
4747

4848
Default waiting spinner uses fontawesome. You can overwrite **async_include/spinner.html** template if don't want to use
4949
the default fontawesome style.
@@ -169,7 +169,7 @@ Note that this templatetag file is **async_included**, ending in **ed**.
169169
## Spinner
170170

171171
Overwrite **async_include/spinner.html** template if you want to change the spinner from fontawesome one (default) by a
172-
background image or a image. Otherwise, make sure you are loading fontawesome fonts.
172+
background image or an image. Otherwise, make sure you are loading fontawesome fonts.
173173

174174
Note that the spinner must have class **async_included-spinner**. Otherwise, the spinner behavior is going to be unpredictable.
175175

@@ -188,7 +188,8 @@ Including the optional parameter **spinner__visible=False** when calling the asy
188188

189189
### Customize spinner template per async_include template tag call
190190

191-
Use the optional parameter **spinner__template_path** to set a diferrent template path for an specific async_include call in your templates.
191+
Use the optional parameter **spinner__template_path** to set a different template path for a specific async_include
192+
call in your templates.
192193

193194
```html
194195
{% load async_include %}
@@ -225,7 +226,7 @@ Customize the wrapper class by passing **html__tag__class** optional parameter t
225226

226227
{# .. #}
227228

228-
{# Will be replaced by <li></li> block insted of <div></div> #}
229+
{# Will be replaced by <li></li> block instead of <div></div> #}
229230
{# Class last_comments will be added to wrapper class #}
230231
{% async_include "boards/components/view/last_comments.html" board=board html__tag='li' html__tag__class='last_comments' %}
231232
```

0 commit comments

Comments
 (0)