README tweak

1 files changed, 30 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 00000000..c3e3d908
--- /dev/null
+++ b/README
@@ -0,0 +1,30 @@
+# Bitcoin Point of Sale
+
+This is a simple utility that a merchant can run on a tablet or phone to convert dollars to bitcoins and receive payments from clients
+
+It uses the websocket payment notification API from http://blockchain.info/ to display notifications in real time.
+
+# Installation
+
+Download market price data from https://mtgox.com/api/1/BTCCAD/ticker into a file called `ticker`:
+
+    wget https://mtgox.com/api/1/BTCCAD/ticker > ticker
+
+
+# License
+
+Copyright (C) 2012 Adam Soltys
+
+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 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.