Register package

.github/workflows/CI.yml

@@ -1,5 +1,7 @@
 name: CI
 on:
+  schedule:
+    - cron: 0 0 * * 0
   push:
     branches:
       - main
@@ -28,7 +30,7 @@ jobs:
           - 'latest'
     steps:
       - uses: actions/checkout@v2
-      - run: docker compose -f test/docker-compose.yml -f test/docker-compose.${{ matrix.lsversion }}.yml up -d --build
+      - run: docker compose -f test/limesurvey/docker-compose.yml -f test/limesurvey/docker-compose.${{ matrix.lsversion }}.yml up -d --build
       - uses: julia-actions/setup-julia@v1
         with:
           version: ${{ matrix.version }}

README.md

@@ -3,9 +3,15 @@
 [![Build Status](https://github.com/p-gw/CitrusAPI.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/p-gw/CitrusAPI.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/p-gw/CitrusAPI.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/p-gw/CitrusAPI.jl)
 
-This Julia package provides a thin wrapper for the [LimeSurvey API](https://manual.limesurvey.org/RemoteControl_2_API). For a list of methods see https://api.limesurvey.org/classes/remotecontrol_handle.html.
+This Julia package provides a wrapper for the [LimeSurvey Remote Control 2 API](https://manual.limesurvey.org/RemoteControl_2_API). 
 
-Note that this package uses a more "julian" syntax for API methods. Methods that mutate data by either adding, deleting or modifying data are implemented as [bang functions](https://docs.julialang.org/en/v1/manual/style-guide/#bang-convention). For example the API method `add_survey` is implemented as the `add_survey!` function in `CitrusAPI.jl`.  
+## Installation
+CitrusAPI is registered in the Julia General package registry. 
+Simply install it by calling
+
+```julia
+pkg> add CitrusAPI
+```
 
 ## Getting started
 If your LimeSurvey server is set up correctly you can start by setting up a `CitrusClient` and connecting to the server. 
@@ -28,6 +34,8 @@ disconnect!(client)
 ```
 
 ## Available methods
+Note that CitrusAPI uses a more "julian" syntax for API methods. Methods that mutate data by either adding, deleting or modifying data are implemented as [bang functions](https://docs.julialang.org/en/v1/manual/style-guide/#bang-convention). For example the API method `add_survey` is implemented as the `add_survey!`.
+
 - `activate_survey!`
 - `activate_tokens!`
 - `add_group!`
@@ -82,4 +90,4 @@ disconnect!(client)
 - `connect!`
 - `disconnect!`
 - `expire_survey!`
-- `is_active`
+- `is_active`

test/limesurvey/Dockerfile

@@ -0,0 +1,3 @@
+ARG LS_VERSION
+FROM acspri/limesurvey:${LS_VERSION}
+COPY ./config.php /var/www/html/application/config/config.php