Update README and CHANGELOG.

Author: brocaar

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## 1.1.0
+
+Note that the changes below are incompatible with LoRa Server
+version <= 0.4.x!
+
+* Small RXPacket and TXPacket changes.
+* Changed to JSON as marshaling format (was Gob).
+
+## 1.0.1
+
+* Update mqtt client vendor to fix various connection issues.
+
+## 1.0.0
+
+* Initial release.

Makefile

@@ -21,7 +21,7 @@ test:
 package: clean build
 	@echo "Creating package"
 	@mkdir -p builds/$(VERSION)
-	@cp -R bin/ builds/$(VERSION)/bin
+	@cp bin/* builds/$(VERSION)
 	@cd builds/$(VERSION)/ && tar -pczf ../lora_semtech_bridge_$(VERSION)_linux_amd64.tar.gz .
 	@rm -rf builds/$(VERSION)
 

README.md

@@ -3,15 +3,30 @@
 [![Build Status](https://travis-ci.org/brocaar/lora-semtech-bridge.svg?branch=master)](https://travis-ci.org/brocaar/lora-semtech-bridge)
 [![GoDoc](https://godoc.org/github.com/brocaar/lora-semtech-bridge/cmd/semtech-bridge?status.svg)](https://godoc.org/github.com/brocaar/lora-semtech-bridge/cmd/semtech-bridge)
 
-*LoRa Semtech Bridge* is a service to handle LoRa gateway (Semtech UDP protocol)
-connections and communication with the ``loraserver`` (https://github.com/brocaar/loraserver).
+*LoRa Semtech Bridge* is a service to enable LoRa gateway communication over MQTT.
+All incoming UDP traffic (Semtech UDP protocol) is published to a MQTT broker and
+all messages received from the MQTT broker are sent to the gateway using UDP.
 
-## Getting started
+This project is part of [LoRa Server](https://github.com/brocaar/loraserver).
+
+## Requirements
+
+#### MQTT broker
+
+[Mosquitto](http://mosquitto.org/) is a popular open-source MQTT server.
 
-* Download and unpack ``semtech-bridge``: https://github.com/brocaar/lora-semtech-bridge/releases
+#### LoRa gateway
+
+Your gateway must be setup so that it sends UDP packets (Semtech UDP protocol).
+Depending upon your LoRa Gateway type, you might need to install the
+[packet_forwarder](https://github.com/TheThingsNetwork/packet_forwarder).
+
+
+## Getting started
 
-* Install a MQTT server (used for communication with ``loraserver``).
-  Mosquitto is a good option: http://mosquitto.org/.
+* Download and unpack a pre-compiled binary from the [releases](https://github.com/brocaar/lora-semtech-bridge/releases)
+  page. Alternatively, build the code from source (when you have a Go development environment
+  ``make build`` should be sufficient).
 
 * Start the ``semtech-bridge`` service. The ``--help`` argument will show
    you all the available config options. When everything is setup correctly
@@ -31,7 +46,7 @@ INFO[0006] outgoing gateway packet                       addr=192.168.1.4:51926
 INFO[0006] backend/mqttpubsub: publishing message        topic=gateway/1dee08d0b691d149/stats
 ```
 
-* Now setup the ``loraserver`` service! https://github.com/brocaar/loraserver
+* Now it is time to setup the [LoRa Server](https://github.com/brocaar/loraserver)!
 
 ## License