Merge pull request #14 from zopefoundation/document_deprecation

Document deprecation of this package.

CHANGES.rst

@@ -4,7 +4,12 @@ Changelog
 5.1 (unreleased)
 ----------------
 
-- Nothing changed yet.
+- Package is now officially deprecated as it was broken for many years. This 
+  was/ is common knowledge in the zope community, but was not documented 
+  anywhere and thus this package was still used by many community members 
+  without knowing this. See
+  (`#8 <https://github.com/zopefoundation/tempstorage/issues/8>`_)
+  (`#12 <https://github.com/zopefoundation/tempstorage/issues/12>`_)
 
 
 5.0 (2019-05-10)

README.rst

@@ -5,3 +5,12 @@ A storage implementation which uses RAM to persist objects, much like
 MappingStorage. Unlike MappingStorage, it needs not be packed to get rid of
 non-cyclic garbage and it does rudimentary conflict resolution. This is a
 ripoff of Jim's Packless bsddb3 storage.
+
+**Please note: Usage of this package is deprecated, as it is known to randomly lose data, especially with Zope 4.**
+
+For a detailed discussion see `#8 <https://github.com/zopefoundation/tempstorage/issues/8>`_ as well as `#12 <https://github.com/zopefoundation/tempstorage/issues/12>`_
+
+To replace server-side sessions, cookies are probably your best bet, as these also get rid of any denial of service problems that server side sessions are vulnerable to.
+
+If you need server side storage of sessions, consider using a normal store rather than tempstorage for your session data.
+For details and suggestions see `this discussion in the pull request <https://github.com/zopefoundation/tempstorage/pull/14#issuecomment-520318459>`_ as well as the discussion in the aforementioned bug reports as well as `the discussion in Zope about the removal of the generated configuration <https://github.com/zopefoundation/Zope/pull/684>`_.