DOC: updated documentation

README.md

-# caoscrawler
+# CaosDB-Crawler
 
-A new crawler for CaosDB.
+## Welcome
 
+This is the repository of the CaosDB-Crawler, a tool for automatic data
+insertion into [CaosDB](https://gitlab.com/caosdb/caosdb-meta).
 
-This package has yaml-header-tools as a dependency:
-https://gitlab.com/salexan/yaml-header-tools
+This is a new implementation resolving  problems of the original implementation
+in [caosdb-advancedtools](https://gitlab.com/caosdb/caosdb-advanced-user-tools)
 
+## Setup
 
+Please read the [README_SETUP.md](README_SETUP.md) for instructions on how to
+setup this code.
 
-This python package can be installed using `pip`, e.g.:
-```bash
-pip install --user .
-```
 
-# Usage
+## Further Reading
 
-work in progress
+Please refer to the [official documentation](https://docs.indiscale.com/caosdb-crawler/) of the CaosDB-Crawler for more information.
 
-# Running the tests
+## Contributing
 
-After installation of the package run (within the project folder):
+Thank you very much to all contributers—[past, present](https://gitlab.com/caosdb/caosdb/-/blob/dev/HUMANS.md), and prospective ones.
 
-```bash
-pytest
-```
+### Code of Conduct
 
-## Integration Tests
-see `integrationtests/README.md`
+By participating, you are expected to uphold our [Code of Conduct](https://gitlab.com/caosdb/caosdb/-/blob/dev/CODE_OF_CONDUCT.md).
 
-# Contributers
+### How to Contribute
 
-The original authors of this package are:
+* You found a bug, have a question, or want to request a feature? Please 
+[create an issue](https://gitlab.com/caosdb/caosdb-crawler).
+* You want to contribute code?
+    * **Forking:** Please fork the repository and create a merge request in GitLab and choose this repository as
+      target. Make sure to select "Allow commits from members who can merge the target branch" under
+      Contribution when creating the merge request. This allows our team to work with you on your
+      request.
+    * **Code style:** This project adhers to the PEP8 recommendations, you can test your code style
+      using the `autopep8` tool (`autopep8 -i -r ./`).  Please write your doc strings following the
+      [NumpyDoc](https://numpydoc.readthedocs.io/en/latest/format.html) conventions.
+* You can also contact us at **info (AT) caosdb.de** and join the
+  CaosDB community on
+  [#caosdb:matrix.org](https://matrix.to/#/!unwwlTfOznjEnMMXxf:matrix.org).
 
-- Alexander Schlemmer
-- Henrik tom Wörden
-- Florian Spreckelsen
+## License
 
-# License
-
-Copyright (C) 2021-2022 Research Group Biomedical Physics, Max Planck Institute for
-Dynamics and Self-Organization Göttingen.
+Copyright (C) 2021-2022 Research Group Biomedical Physics, Max Planck Institute
+                        for Dynamics and Self-Organization Göttingen.
 Copyright (C) 2021-2022 IndiScale GmbH
 
 All files in this repository are licensed under a [GNU Affero General Public

README_SETUP.md

+src/doc/README_SETUP.md
\ No newline at end of file

src/doc/README_SETUP.md

@@ -4,6 +4,8 @@
 
 ### Requirements ###
 
+This package has yaml-header-tools as a dependency:
+https://gitlab.com/salexan/yaml-header-tools
 
 ### How to install ###