From 897fdd89d6893172e1e63e4fdece4e5cce0995cc Mon Sep 17 00:00:00 2001
From: Leo Arias <leo.arias@canonical.com>
Date: Sun, 3 Dec 2017 16:31:42 +0000
Subject: [PATCH] Updated the README with install instructions

---
 README.md | 16 +++++++++++++++-
 ipfs      | 21 +++++++++++++++++++++
 2 files changed, 36 insertions(+), 1 deletion(-)
 create mode 100644 ipfs

diff --git a/README.md b/README.md
index f1ff8a6..52ab685 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,16 @@
-# apt-transport-ipfs
 IPFS transport for apt
+
+# Requirements
+
+    sudo apt install python3 pip
+    sudo pip3 install ipfsapi
+
+# Install
+
+Copy the ipfs file from this repo to the directory for apt transport methods:
+
+    sudo wget --output-file /usr/lib/apt/methods/ipfs https://raw.githubusercontent.com/JaquerEspeis/apt-transport-ipfs/master/ipfs
+
+# Configure
+
+Add to your apt sources.list file an IPFS mirror. TODO set up a mirror.
diff --git a/ipfs b/ipfs
new file mode 100644
index 0000000..c8df56b
--- /dev/null
+++ b/ipfs
@@ -0,0 +1,21 @@
+#!/usr/bin/python3 -u
+# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4 -*-
+#
+# Copyright (C) 2014-2015, 2017 Bashton Ltd
+# Copyright (C) 2017 JaquerEspeis
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# 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, see <http://www.gnu.org/licenses/>.
+
+# IPFS transport for apt.
+# This is based on apt-transport-s3:
+# https://github.com/BashtonLtd/apt-transport-s3