Added upstart script

[mtetherd] / README

diff --git a/README b/README
index 613db3f..ada9d53 100644 (file)
--- a/README
+++ b/README
@@ -1,20 +1,25 @@
-maemo-tethering 1.0
--------------------
+mtetherd 0.1
+------------
 
 Description:
 
-maemo-tethering allows you to use your N900 as an Internet router.
+mtetherd allows you to use your N900 as an Internet router.
 Once a USB network or Bluetooth PAN connection is opened to the device,
 it will automatically configure networking and start a dnsmasq instance
 that serves DHCP requests and forwards DNS queries.
-This tool can also be used to automatically configure network interfaces
+You can also use it to automatically configure network interfaces
 for development.
 
+Requirements:
+
+The iptables and bluetooth-dun packages must be installed.
+They are required for setting up NAT and Bluetooth PAN support.
+
 Usage:
 
 Bluetooth:
 1. Pair your host with the N900 and make sure the PAN (Bluetooth networking)
-   service is recognized.
+   service is recognized on the host.
 2. Open a PAN connection to the N900.
 3. Routing should setup automatically and you can access the Internet
    right away.
@@ -28,7 +33,7 @@ USB:
 6. The USB mode is kept between cable disconnects, you only have to
    reload the g_ether module after a reboot or mode change.
 7. Start surfing on the host.
-3a.It is also possible to load the module from the Terminal:
+3a.It is also possible to load the module from the Terminal (untested):
 rmmod g_nokia
 rmmod g_file_storage
 modprobe g_ether
@@ -36,7 +41,7 @@ modprobe g_ether
 Notes:
 
 IP addresses are currently hardcoded into the program. A later version
-will add support for a configuration file.
+will add support for an external configuration file.
 The assigned addresses are the following:
 USB: N900: 192.168.253.254 DHCP: 192.168.253.1-192.168.253.253
 Bluetooth: N900: 192.168.254.254 DHCP: 192.168.254.1-192.168.254.253
@@ -48,8 +53,15 @@ You can still communicate with the device, but not surf the internet
 from your host. Just disconnect and reconnect again when the GPRS/UMTS
 connection is available.
 
+Bugs:
+
+Likely.
+Please submit a bug report on garage.maemo.org if you find any!
+
 Legal:
 
+mtetherd is (c) 2010 by Gregor Riepl <onitake@gmail.com>
+
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or