Update maintenance goals

README.rst

@@ -1,3 +1,19 @@
+Eventlet
+========
+
+.. image:: https://img.shields.io/pypi/v/eventlet
+    :target: https://pypi.org/project/eventlet/
+
+.. image:: https://img.shields.io/github/actions/workflow/status/eventlet/eventlet/test.yaml?branch=master
+    :target: https://github.com/eventlet/eventlet/actions?query=workflow%3Atest+branch%3Amaster
+
+.. image:: https://codecov.io/gh/eventlet/eventlet/branch/master/graph/badge.svg
+    :target: https://codecov.io/gh/eventlet/eventlet
+
+.. warning::
+   before considering new uses of eventlet be sure to read the project
+   guideline at the end of this `README` file.
+
 Eventlet is a concurrent networking library for Python that allows you to change how you run your code, not how you write it.
 
 It uses epoll or libevent for highly scalable non-blocking I/O.  Coroutines ensure that the developer uses a blocking style of programming that is similar to threading, but provide the benefits of non-blocking I/O.  The event dispatch is implicit, which means you can easily use Eventlet from the Python interpreter, or as a small part of a larger application.
@@ -12,7 +28,7 @@ applications to use it.  Start off by looking at the `examples`_,
 
 
 Quick Example
-===============
+=============
 
 Here's something you can try right on the command line::
 
@@ -26,7 +42,7 @@ Here's something you can try right on the command line::
 
 
 Getting Eventlet
-==================
+================
 
 The easiest way to get Eventlet is to use pip::
 
@@ -47,34 +63,19 @@ To build a complete set of HTML documentation, you must have Sphinx, which can b
 
 The built html files can be found in doc/_build/html afterward.
 
-
-Twisted
-=======
-
-Eventlet had Twisted hub in the past, but community interest to this integration has dropped over time,
-now it is not supported, so with apologies for any inconvenience we discontinue Twisted integration.
-
-If you have a project that uses Eventlet with Twisted, your options are:
-
-* use last working release eventlet==0.14
-* start a new project with only Twisted hub code, identify and fix problems. As of eventlet 0.13, `EVENTLET_HUB` environment variable can point to external modules.
-* fork Eventlet, revert Twisted removal, identify and fix problems. This work may be merged back into main project.
-
-Apologies for any inconvenience.
-
 Supported Python versions
 =========================
 
 Python 3.7-3.12 are currently supported.
 
-Flair
-=====
-
-.. image:: https://img.shields.io/pypi/v/eventlet
-    :target: https://pypi.org/project/eventlet/
+Project Guideline
+=================
 
-.. image:: https://img.shields.io/github/actions/workflow/status/eventlet/eventlet/test.yaml?branch=master
-    :target: https://github.com/eventlet/eventlet/actions?query=workflow%3Atest+branch%3Amaster
+Eventlet was created almost 18 years ago, at a time where async features
+were absent from the CPython stdlib. With time eventlet evolved and CPython
+too, but since several years the maintenance activity of eventlet dicreased
+leading to a growing gap between eventlet and the CPython implementation.
 
-.. image:: https://codecov.io/gh/eventlet/eventlet/branch/master/graph/badge.svg
-    :target: https://codecov.io/gh/eventlet/eventlet
+New usages of eventlet are now heavily discouraged. Eventlet is now switching
+to legacy mode, i.e, only maintenance for stability and bug fixing, no new
+features, discourage usage in new projects.

doc/index.rst

@@ -1,6 +1,10 @@
 Eventlet Documentation
 ====================================
 
+.. warning::
+   before considering new uses of eventlet be sure to read the project
+   guideline at the end of this `README` file.
+
 Code talks!  This is a simple web crawler that fetches a bunch of urls concurrently:
 
 .. code-block:: python
@@ -53,6 +57,18 @@ License
 ---------
 Eventlet is made available under the terms of the open source `MIT license <http://www.opensource.org/licenses/mit-license.php>`_
 
+Project Guideline
+=================
+
+Eventlet was created almost 18 years ago, at a time where async features
+were absent from the CPython stdlib. With time eventlet evolved and CPython
+too, but since several years the maintenance activity of eventlet dicreased
+leading to a growing gap between eventlet and the CPython implementation.
+
+New usages of eventlet are now heavily discouraged. Eventlet is now switching
+to legacy mode, i.e, only maintenance for stability and bug fixing, no new
+features, discourage usage in new projects.
+
 Indices and tables
 ==================