README.rst

@@ -1,33 +1,18 @@
 **This plugin is obsolete. ``setuptools_scm >= 7.0.0`` supports Git archives by itself.**
 
-This is a `setuptools_scm <https://pypi.python.org/pypi/setuptools_scm>`_ plugin
-that adds support for git archives (for example the ones GitHub automatically
-generates).
+Migration guide
+---------------
 
-Note that it only works for archives of tagged commits (because git currently
-lacks a format option equivalent to ``git describe --tags``).
-
-Usage
------
-
-Add ``'setuptools_scm_git_archive'`` to the ``setup_requires`` parameter in your
-project's ``setup.py`` file:
-
-.. code:: python
-
-    setup(
-        ...,
-        use_scm_version=True,
-        setup_requires=['setuptools_scm', 'setuptools_scm_git_archive'],
-        ...,
-    )
-
-Create a ``.git_archival.txt`` file with the following content::
+Change the contents of the ``.git_archival.txt`` file in the root directory of your repository from::
 
     ref-names: $Format:%D$
 
-Then add this line to the ``.gitattributes`` file::
+to::
 
-    .git_archival.txt  export-subst
+    node: $Format:%H$
+    node-date: $Format:%cI$
+    describe-name: $Format:%(describe)$
+    ref-names: $Format:%D$
 
-Finally, don't forget to commit these two files.
+Remove ``setuptools_scm_git_archive`` from your project's dependencies (e.g. the
+``setup_requires`` list in your ``setup.py`` file).