From 185baaec7941f2abb09c90624c7678ee6260df03 Mon Sep 17 00:00:00 2001 From: Nikita Marchant Date: Tue, 26 Dec 2023 12:49:31 +0100 Subject: [PATCH] Add more deprecation warnings --- README.md | 11 +++++++++-- doc/source/index.rst | 2 +- doc/source/topics/quickstart.rst | 10 +++++++++- doc/source/tutorial/index.rst | 13 +++++++++++-- 4 files changed, 30 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 288af10..b18c561 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,15 @@ [![Issues](https://img.shields.io/github/issues/hotwire-django/turbo-django)](https://img.shields.io/github/issues/hotwire-django/turbo-django) [![Twitter](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2FDjangoHotwire)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fhotwire-django%2Fturbo-django) -# Turbo for Django - +# Unmaintained // Turbo for Django + +> [!WARNING] +> This library is unmaintained. Integrating Hotwire and Django is so easy +> that you are probably better served by writing a little bit of Python in your code +> than using a full-blown library that adds another level of abstraction. +> It also seems that the Django community is leaning more towards HTMX than Hotwire +> so you might want to look over there if you want more "support" +> (but we still think that Hotwire is very well suited to be used with Django) Integrate [Hotwire Turbo](https://turbo.hotwired.dev/) with Django with ease. diff --git a/doc/source/index.rst b/doc/source/index.rst index 401414e..46e3100 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -8,7 +8,7 @@ -Turbo Django +Unmaintained // Turbo Django ============ Turbo Django is a project that integrates the `Hotwire Turbo framework `_ with `Django `_, allowing for rendered page updates to be delivered live, over the wire. By keeping template rendering in Django, dynamic and interactive web pages can be written without any serialization frameworks or JavaScript, dramatically simplifying development. diff --git a/doc/source/topics/quickstart.rst b/doc/source/topics/quickstart.rst index 612463d..00fc2b0 100644 --- a/doc/source/topics/quickstart.rst +++ b/doc/source/topics/quickstart.rst @@ -1,5 +1,13 @@ +.. warning:: + This library is unmaintained. Integrating Hotwire and Django is so easy + that you are probably better served by writing a little bit of Python in your code + than using a full blown library that adds another level of abstraction. + It also seems that the Django community is leaning more towards HTMX than Hotwire + so you might want to look over there if you want more "support" + (but we still think that Hotwire is very well suited to be used with Django) + ========== -Quickstart +Unmaintained//Quickstart ========== Want to see Turbo in action? Here's a simple broadcast that can be setup in less than a minute. diff --git a/doc/source/tutorial/index.rst b/doc/source/tutorial/index.rst index d2dd6ab..38c5ade 100644 --- a/doc/source/tutorial/index.rst +++ b/doc/source/tutorial/index.rst @@ -1,4 +1,13 @@ -Tutorial +.. warning:: + This library is unmaintained. Integrating Hotwire and Django is so easy + that you are probably better served by writing a little bit of Python in your code + than using a full blown library that adds another level of abstraction. + It also seems that the Django community is leaning more towards HTMX than Hotwire + so you might want to look over there if you want more "support" + (but we still think that Hotwire is very well suited to be used with Django) + + +Unmaintained//Tutorial ======== Turbo-Django allows you to easily integrate the Hotwire Turbo framework into your @@ -12,7 +21,7 @@ those messages immediately. .. toctree:: :maxdepth: 1 - + part_1 part_2 part_3