diff --git a/README.md b/README.md index 53d100a..df239d0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# yacy-maintenance-scripts +# YaCy Maintenance Scripts Scripts for easily maintaining your YaCy instance @@ -9,6 +9,15 @@ Scripts for easily maintaining your YaCy instance - Using "yacynet" as docker container name - Default Solr collection must be called "collection1" -This requirements are basic to make this scripts function right out of the box. -You can make any modifications to the scripts to suit your needs (in case you don't use docker or have different parameters) +This requirements are basic to **make this scripts work right out of the box**. +You can make **any modifications to the scripts** to suit your needs (in case you don't use docker or have different parameters) + +## Installation + +Just **clone the repo somewhere** on your server + +## Usage + +Execute the wrapper scripts located at `x/`, depending on the **action you want to do**. +This scripts can also be **called into a cron job** directly