Release 1.0.1 preparations

Author: sauterl

.gitignore

@@ -1,3 +1,9 @@
+# Custom Ignorings
+# Everything generated.
+[Gg]enerated
+[Gg]enerated/**
+Generated.meta
+
 # Created by https://www.gitignore.io/api/rider,unity
 # Edit at https://www.gitignore.io/?templates=rider,unity
 

CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
 
+## [1.0.1] - 2021-11-29
+
+* Moved to `Dev.Dres` namespace
+* Enhanced README documentation for users
+* Added code documentation for developers
+
 ## [1.0.0] - 2021-10-21
 This is the first release of the DRES Unity API package compatible with the DRES OpenAPI version 1.0.

README.md

@@ -2,20 +2,60 @@
 
 An interface for [DRES](https://github.com/dres-dev/DRES), meant to be used in [Unity](https://unity.com/).
 
-**Note: This is heavily Work-in-Progress**
+## Usage / Installation
 
-## Usage
+This is a upm package, add it through the [Unity Package Manager](https://docs.unity3d.com/Manual/Packages.html) as a package from git using the URL `https://github.com/vitrivr/DresUnityInterface.git#main` or directly by adding the following to your `manifest.json` for latest version:
 
-This is a upm package, add it through the Unity package manager as a package from git using the URL `https://github.com/vitrivr/DresUnityInterface.git#main` or directly by adding the following to your `manifest.json` for latest version:
+```json
+"dev.dres.unityclient": "https://github.com/vitrivr/DresUnityInterface.git#main"
+```
+
+## Configuration
+
+This package requires a config file, `dresapi.json` to be located either at
+
+* `Assets/` (corresponds to [`Application.dataPath`](https://docs.unity3d.com/ScriptReference/Application-dataPath.html) for Unity Editor)
+* The persistent data folder for your platform (i.e. where [`Application.persistentDataPath`](https://docs.unity3d.com/ScriptReference/Application-persistentDataPath.html) points to)
+
+The configuration file contains vital information about DRES:
 
 ```json
-"org.vitrivr.unityinterface.dresapi": "https://github.com/vitrivr/DresUnityInterface.git#main"
+"host": "example.com/dres",
+"port": 443,
+"tls": true,
+"user": "username",
+"password": "password"
+```
+
+* `host`: the host address of the DRES instance, either an IP or name (defaults to `localhost`)
+* `port`: the port of the DRES instance (defaults to `8080`)
+* `tls`: whether to use tls or not, i.e. the API calls will be `https` with `true`, `false` otherwise (defaults to `false`)
+* `user`: the DRES user name (+)
+* `password`: the DRES user passwor (+)
+
+(+): Could be omitted and provided in a separate file (`credentials.json`), as a sibling to the config file:
+
+```json
+"user":"username",
+"password":"password"
 ```
 
 ## Development
 
 For development, clone this repository into a directory `org.vitrivr.unityinterface.dresapi` inside the Packages directory of the Unity project you want to develop in.
 
+```
+$> git clone [email protected]:vitrivr/DresUnityInterface.git org.vitrivr.unityinterface.dresapi
+```
+
+And subsequently (re-) generate the client libraries:
+
+```
+$> gradlew clean deploy
+```
+
+For developers, it might be necessary to re-open the unity project multiple times, until the pre-checks are okay.
+
 ## Contributors
 
 - Florian Spiess [@Spiess](https://github.com/Spiess)