Improved documentation #70

README.md

@@ -62,17 +62,20 @@ mvn clean package
 
 ### Installation
 
-TODO: Service scripts and other necessary stuff for "properly installing" this will be added later.
-For now, you can do the following to the this up and running:
+#### Automatic Setup
+Service scripts and other necessary stuff for "properly installing" this are
+available in the [service-setup](service-setup/README.md) directory.
 
-- hcitool and hcidump require additional capabilities, so you need to execute the following commands or run the application as root
+#### Manual Setup
+- hcitool and hcidump require additional capabilities to be run as a normal user, so you need to execute the following commands or run the application as root
 
 ```sh
 sudo setcap 'cap_net_raw,cap_net_admin+eip' `which hcitool`
 sudo setcap 'cap_net_raw,cap_net_admin+eip' `which hcidump`
 ```
 
-- Run the built JAR-file with `java -jar ruuvi-collector-*.jar`. Note: as there is no service scripts yet, it's recommended to run this for example inside *screen* to avoid the application being killed when terminal session ends
+- Run the built JAR-file with `java -jar ruuvi-collector-*.jar`
+  - Note: it's recommended to run this for example inside *screen* to avoid the application being killed when terminal session ends
 - To configure the settings, copy the `ruuvi-collector.properties.example` to `ruuvi-collector.properties` and place it in the same directory as the JAR file and edit the file according to your needs.
 
 ### Configuration

service-setup/README.md

@@ -1,11 +1,12 @@
 # Quickstart
 To install RuuviCollector as a service and write collected data to an InfluxDB
-database, you can run setup.sh from this directory.
+database, you can run setup.sh from this directory after cloning the repo.
 
 ```sh
 # Here's an example, you'd have to change the database URL, username, password,
 # and database name accordingly to suit your deployment.
-./setup.sh -d "https://database.example.com:8086" -u ruuvi_user -p hunter2 -n ruuvitags
+git clone https://github.com/Scrin/RuuviCollector
+./RuuviCollector/service-setup/setup.sh -d "https://database.example.com:8086" -u ruuvi_user -p hunter2 -n ruuvitags
 ```
 
 All files are installed into /opt/ruuvicollector