DOC: add info on how to update

CHANGELOG.md

@@ -13,8 +13,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed ###
 
-- There are no DictXYElements any more. For example, DictTextElement is now
-  simply a TextElement.  The behavior of the following classes changed:
+- The DictXYElements are now depricated. For example, instead of
+  DictTextElement you should use simply a TextElement. See READ
+  See The behavior of the following classes changed:
   - DictElementConverter (old: DictConverter) now can use "match" keywords. If
     none are in the definition, the behavior is as before.
   - TextElement used the 'match' keyword before, which was applied to the

src/doc/README_SETUP.md

@@ -56,13 +56,6 @@ pip3 install --user .
 
 **Note**: In the near future, this package will also be made available on PyPi.
 
-## Configuration ##
-
-
-
-## Try it out ##
-
-
 
 ## Run Unit Tests
 

src/doc/how-to-upgrade.md

+
+# How to upgrade
+
+## 0.2.x to 0.3.0
+If you had "match", "match_name" or "match_value" in the definition of a
+DictConverter (StructureElement: Dict) before,
+you probably want to remove those. They were ignored before and are now used.
+
+If you used the 'match' keyword in the definition of TextElementConverter
+(StructureElement: TextElement) before, you need to change the key from "match"
+to "match_name" in order to preserve the behavior.

src/doc/index.rst

@@ -13,6 +13,7 @@ CaosDB-Crawler Documentation
    CFoods (Crawler Definitions)<cfood>
    Macros<macros>
    Tutorials<tutorials/index>
+   How to upgrade<how-to-upgrade>
    API documentation<_apidoc/modules>
 
       
@@ -40,5 +41,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-
-