diff --git a/Actions-annotatet.PNG b/Actions-annotatet.PNG new file mode 100644 index 0000000..ad0619f Binary files /dev/null and b/Actions-annotatet.PNG differ diff --git a/Dependabot-annotatet.PNG b/Dependabot-annotatet.PNG new file mode 100644 index 0000000..588e35d Binary files /dev/null and b/Dependabot-annotatet.PNG differ diff --git a/README.md b/README.md index a52aa05..2823095 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ The project has currently the following entrypoint available: - **find-missing-companies** > Retrieves meta information of companies referenced by others but not yet part of the dataset. - **ingest** > Scheduled data ingestion of news articles as well as missing companies and financial data. -All entrypoints support the `-h` argument and show a short help. +All entrypoints support the `-h` argument that shows a short help text. ## Applikation startup @@ -126,3 +126,19 @@ To use the `*.json` use the path to it as an argument when using an entrypoint ( We support both sqlite and postgres because a local db is filled in about 10% of the time the remote db needs to be completed. Even tough we use the `sqlite` for testing the connection can't manage multithreading or multiprocessing. This clashes with the webserver. For production mode use the `postgres`-db. + +## Re-Enable Actions & Dependabot + +After the project is over all computation using parts should be turned off. + +To enable all the features please enable the GitHub Actions first. +The following image shows where the buttons to enable the actions can be found. + +![Actions](Actions-annotatet.PNG) + +Additionally, it is recommended to enable Dependabot. +Please note that patches are currently only demanded for critical security fixes. +Use `poetry update` prior to restarting the project to update all the python dependencies. +Note that both security updates and alerts should be enabled. + +![Dependabot](Dependabot-annotatet.PNG) diff --git a/documentations/Actions-annotatet.PNG b/documentations/Actions-annotatet.PNG new file mode 100644 index 0000000..ad0619f Binary files /dev/null and b/documentations/Actions-annotatet.PNG differ diff --git a/documentations/Dependabot-annotatet.PNG b/documentations/Dependabot-annotatet.PNG new file mode 100644 index 0000000..588e35d Binary files /dev/null and b/documentations/Dependabot-annotatet.PNG differ