diff --git a/README.md b/README.md index 0fc7cd3c2df8e592fd48c6a4aea981b88f1ce35e..6abb96b6c1770b81f7ae173f111698561c177d1d 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,20 @@ # Transcend Wifi SD Photo Downloader/Viewer -This Node.js app searches your Transcend Wifi SD and waits for photos to be taken ("Shoot & View"), which it then downloads to a specified folder and displays in a webinterface. +This Node.js app searches for a Transcend Wifi SD on the local network and waits for photos to be taken ("Shoot & View" mode of the mobile app). +When it detects that a photo was taken, it will download that photo to a specified folder. + +The app also features a simple but functional web interface that will display the last photo taken, e.g. for live previewing during a photo shooting. ## Usage -- Make sure you have Node.js installed +- Make sure you have Node.js and NPM installed - Copy ```config.json-dist``` to ```config.js``` and edit it to your needs - Run ```npm install``` - Start with ```npm start``` -- Open a browser and access ```http://127.0.0.1:80``` (replace IP and port according to your changes) +- Open a browser and access ```http://127.0.0.1:80``` (replace IP and port according to your configuration changes) If your Wifi SD is on the same network as the one detected/configured, you should see that the card is found and the app is waiting for photos to be taken. ## Troubleshooting - Tested on Debian (jessie) with Node.js v0.10.32 -- If you card is not found, make sure it is connected to the same subnet as the machine running this app -- If you don't know your "broadcast address", remove that line 'broadcastAddr' from config.json check if the right address is detected +- If you card is not found, make sure it is connected to the same network as the machine running this app. Different subnets won't work. +- If you don't know your "broadcast address", remove that line 'broadcastAddr' from config.json check if the right address is detected. (Hint: if your IP address is 192.168.0.11, the broadcast address will most likely be 192.168.0.255 - at least on a regular home network.)