diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..170dd4e --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +build/* +dist/* +simpleanalytics.egg-info diff --git a/README.md b/README.md index 7096c34..f99b571 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,19 @@ -# simpleanalytics for Django +# Simple Analytics for Django + Want privacy friendly analytics for Django? You're at the right place. +> You need an account [on Simple Analytics](https://simpleanalytics.com) to see your stats collected by this plugin. + # Installing it + Install the plugin: `pip install django-simpleanalytics` # Using it + Add the package to the `INSTALLED_APPS`: -```python +```python INSTALLED_APPS = [ ..., simpleanalytics, @@ -16,7 +21,8 @@ INSTALLED_APPS = [ ``` Next use the `templatetag` in your template: -``` + +``` {% load staticfiles simpleanalytics_tags %} @@ -60,17 +66,17 @@ This app has four templatetags: - simpleanalytics_sync - simpleanalytics_async - simpleanalytics_noscript_block -- simpleanalytics_noscript_img +- simpleanalytics_noscript_img `simpleanalytics_sync` converts to a plain `