Updated readme

README.md

@@ -7,6 +7,8 @@ IXI plugin for [Ict](https://github.com/iotaledger/ict) to report node informati
 
 ## Installation
 
+`Ict WebGUI > Manage Modules > Install Third Party Plugin > "trifel/Report.ixi"`
+
 Go to [releases](https://github.com/trifel/Report.ixi/releases) and download `report.ixi-{VERSION}.jar` from the most recent release. 
 
 Alternatively, you can build the .jar file from the source code (advanced users). **Git** and **Gradle** is required for the following steps:
@@ -15,69 +17,17 @@ git clone https://github.com/trifel/Report.ixi
 cd Report.ixi
 gradle fatJar
 ```
+And move the .jar file into Ict's `modules/`-directory.
 
 ## Configure
 
-### Adjust the Ict config file
-
-In your **ict.cfg** file, make sure that `ixi_enabled` is set to `true`:
-
-```
-ixi_enabled=true
-```
-
-### Create and adjust the Report.ixi config file
-
-Create or open the **report.ixi.cfg** file and complete the settings.
+`Ict WebGUI > IXI Modules > Report.ixi`
 
-```
-// The host IP address is used to create the UDP socket. 
-// If the IP address is 0.0.0.0, the socket will be bound to the wildcard address, 
-// an IP address chosen by the kernel. Mostly you don`t need to change the host IP.
-host=0.0.0.0
-
-// The name of your Ict Client which is configured in the ict.cfg file. This name
-// is only used for the RMI connection between Report.ixi and the Ict Client.
-// The default value is set to "ict".
-ictName=ict
-
-// The additional port of the Report.ixi application of your instance. 
-// This additional port is not the Ict port.
-reportPort=1338
-
-// optional: 
-// Must be defined if the external report port is different from the internal.
-externalReportPort=1338
-
-// A simple name chosen by the Ict operator for this Ict node.
-// There is no guarantee that this name is unique, multiple Ict nodes may
-// use the same name. Follow the naming convention: "<name> (ict-<number>)", e.g. 
-// "ixuz (ict-0)" or "testIT (ict-0)".
-name=
-
-// Add host and port of your neighbors Report.ixi (comma separated, no whitespace).
-// Please note that the port numbers should refer to your neighbor's Report.ixi operational port.
-neighbors=10.10.10.10:1338,20.20.20.20:1338,public.address.to.neighbor:1338
-```
-
-### Port forwarding, firewall settings
-
-The Report.ixi application will only operate correctly, if you open or forward the additional UDP port (`reportPort`, which is defined in the file `report.ixi.cfg`) in your router and/or firewall settings.
-
-## Run Report.ixi
-
-### Step 1: Start your Ict Client
-
-```shell
-java -jar ict-{VERSION}.jar
-```
-
-### Step 2: Start Report.ixi
-
-```shell
-java -jar report.ixi-{VERSION}.jar
-```
-If your **report.ixi.cfg** file is not in the same directory, you can set the path as argument:
-```shell
-java -jar report.ixi-{VERSION}.jar ../report.ixi.cfg
-```
+ * `Ict REST API Port`: Set the Ict WebGUI port number.
+ * `Ict REST API Password`: Set the password needed to access Ict WebGUI.
+ * `Name`: Set the name that your node will be identifying itself as, the accepted format is `name (ict-0)`.
+   * Replace the `name` with your own personalized name.
+   * If you run more than one Ict, increment the integer at the end of the name. 
+ * `Neighbors`: You will most likely not need to edit this field as it will automatically get populated when successfully configuring `Ict REST API Port` and `Ict REST API Password`
+   * `publicAddress`: It's possible to override the public address associated with a neighbor, but this is uncommon.
+ * `Public Address`: Enter your own node's publically known `address:port`