From e725475a1a3c3b7bd9eeeaf2c40a2f2fb0a9468b Mon Sep 17 00:00:00 2001 From: erdem Date: Mon, 24 Jun 2024 19:12:57 +0100 Subject: [PATCH] Update intro text in README.md --- README.md | 4 +-- README.rst | 2 +- docs/contribution/index.rst | 5 +-- docs/index.rst | 2 +- docs/releases/index.rst | 66 +++++++++++++++++++++++++------------ 5 files changed, 52 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 9ffce44..743155f 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ overall development experience. The primary goal of Django Map Widgets is to bridge the gap between powerful GeoDjango functionality and user-friendly map interactions, creating a more accessible and enjoyable experience for both developers and end-users of -GeoDjango-powered applications. +GeoDjango-powered applications. Currently, the package supports Google, Mapbox, and Leaflet mapping platforms. @@ -28,7 +28,7 @@ GeoDjango-powered applications. ### Installation ```shell - pip install django-map-widgets +pip install django-map-widgets ``` Add ‘mapwidgets’ to your `INSTALLED_APPS` in settings.py diff --git a/README.rst b/README.rst index 0db1d29..3229d44 100644 --- a/README.rst +++ b/README.rst @@ -10,7 +10,7 @@ overall development experience. The primary goal of Django Map Widgets is to bridge the gap between powerful GeoDjango functionality and user-friendly map interactions, creating a more accessible and enjoyable experience for both developers and end-users of -GeoDjango-powered applications. +GeoDjango-powered applications. Currently, the package supports Google, Mapbox, and Leaflet mapping platforms. .. image:: https://github.com/erdem/django-map-widgets/assets/1518272/f2df8654-b29a-4d64-9159-87a3790ede0b :alt: Mapbox Interactive Widget diff --git a/docs/contribution/index.rst b/docs/contribution/index.rst index e48ad39..c31dd72 100644 --- a/docs/contribution/index.rst +++ b/docs/contribution/index.rst @@ -19,13 +19,14 @@ Map Widget Development Overview Before beginning development, familiarize yourself with the current widget implementation approach. A typical widget consists of five main elements: 1. Django widget class implementation -2. Settings namespace +2. Settings namespace Key 3. jQuery class and CSS implementation (preferably minified) 4. Widget HTML template 5. Usage documentation -As a bonus, implementing tests for your widget is highly encouraged. For optimal performance, consider using ``uglifycss`` and ``uglifyjs`` Node.js packages to generate minified versions of your static files. See ``scripts.py`` file to how you can automate static files minification. +As a bonus, implementing tests for your widget is highly encouraged. For optimal performance, consider using ``uglifycss`` and ``uglifyjs`` Node.js packages to generate minified versions of your static files. See `scripts.py `_ file to how you can automate static files minification. +if you need hand with your contribution, feel free to open a thread on `GitHub Discussions `_. Setting Up the Development Environment -------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 961f95e..a05c3ff 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,7 +8,7 @@ overall development experience. The primary goal of Django Map Widgets is to bridge the gap between powerful GeoDjango functionality and user-friendly map interactions, creating a more accessible and enjoyable experience for both developers and end-users of -GeoDjango-powered applications. +GeoDjango-powered applications. Currently, the package supports Google, Mapbox, and Leaflet mapping platforms. * `Home Page `_ diff --git a/docs/releases/index.rst b/docs/releases/index.rst index ca1871c..6076af8 100644 --- a/docs/releases/index.rst +++ b/docs/releases/index.rst @@ -2,68 +2,92 @@ Release Notes ============= +0.5.0 +^^^^^ + + This release introduces significant changes and improvements to Django Map Widgets, including breaking changes to the settings structure and widget behaviour. + + Key changes: + + - Added Leaflet interactive widget support + - Added Mapbox static widget support + - Enhanced interactive widget UX for improved user experience + - Updated GoogleMap widget to address JS deprecation warnings and initialisation issues + - Resolved bugs in MapBox Interactive widget + - New settings structure introduced. + - Refreshed demo project to showcase all widget usages in Django 5.x + - Upgraded package to support Python 3.12 + - Revised all documents. + - Added contribution guide documentation. + - Poetry package manager started being used for development purposes. + - Added `black` and `isort` integration. + - Removed outdated functional and unit tests + - Removed Travis integration + - Removed Docker Integration + + 0.4.2 ^^^^^ - - GooglePointFieldInlineWidget bug fixes for Django 4.2.x (#142), thanks for @isarota. - - Added `.readthedocs.yaml` to cover new **Read the Docs** updates. + - GooglePointFieldInlineWidget bug fixes for Django 4.2.x (#142), thanks for @isarota. + - Added `.readthedocs.yaml` to cover new **Read the Docs** updates. 0.4.1 ^^^^^ - - Added scroll wheel zooming functionality switch to Google Point Map Settings. (#134) - - Added Chinese(ZH) localisation support. (#133) + - Added scroll wheel zooming functionality switch to Google Point Map Settings. (#134) + - Added Chinese(ZH) localisation support. (#133) 0.4.0 ^^^^^ - - Supported MapBox Map for Geo Point Field - - Fixed javascript triggers undefined place object binding issue. (#125) - - Documented MapBox point field map widget - - Updated various localize files. + - Supported MapBox Map for Geo Point Field + - Fixed javascript triggers undefined place object binding issue. (#125) + - Documented MapBox point field map widget + - Updated various localize files. 0.3.3 ^^^^^ - - Replaced + - Replaced `ugettext_lazy `__ usages with `gettext_lazy `__ for Django 4.0. (#127) - - Updated `Travis CI + - Updated `Travis CI file `__. (#129) 0.3.1 ^^^^^ - - Added + - Added `streetViewControl `__ switch to GooglePointFieldWidget settings. (#124) 0.3.1 ^^^^^ - - Removed ``six`` package usages. (#117) - - Added a new general widget setting in order to specify Google JS + - Removed ``six`` package usages. (#117) + - Added a new general widget setting in order to specify Google JS libraries. (#119) - - Implemented some improvements for the demo project. + - Implemented some improvements for the demo project. 0.3.0 ^^^^^ - - Implemented a new demo project with Django 2.x. - - Fixed Django Admin jQuery conflicts. (#100) - - Fixed a new widget JS instance initialising issue for Django Admin + - Implemented a new demo project with Django 2.x. + - Fixed Django Admin jQuery conflicts. (#100) + - Fixed a new widget JS instance initialising issue for Django Admin Inlines. (#84) - - Added Python 3.8 env settings to TravisCI configuration. + - Added Python 3.8 env settings to TravisCI configuration. 0.2.3 ^^^^^ - - Fixed python ``six`` module import issue. - - Fixed PostGIS setup errors in CI pipeline. - - Added Estonian language support. + - Fixed python ``six`` module import issue. + - Fixed PostGIS setup errors in CI pipeline. + - Added Estonian language support. 0.2.0