From 12c24df6db9ef26694a154d1e1ec13bd4fd9f582 Mon Sep 17 00:00:00 2001
From: Drew Harwell <fenwick67@users.noreply.github.com>
Date: Sun, 30 Apr 2017 13:03:49 -0500
Subject: [PATCH] Create README.md

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c6baa6a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Mastofeed
+
+Embed a mastodon feed in your blog et cetera.
+
+## Usage guide
+
+The homepage has a tool for generating iframe code for you, with a sensible `sandbox` attribute.  The feeds fit comfortably in a 400px wide area.
+
+## API
+
+### GET `/api/feed?url=${url}`
+
+> example: `/api/feed/url=https%3A%2F%2Foctodon.social%2Fusers%2Ffenwick67.atom`
+
+Returns a html page which displays a mastodon feed for an atom feed URL.  Note that URLs must be URI encoded (i.e. `encodeURIComponent('https://octodon.social/users/fenwick67.atom')` ).
+
+Mastodon Atom feed URLs follow this convention:
+
+`https://${instance}/users/${username}.atom`
+
+## Installation
+
+This is a straightforward node project with zero databases or anything, you should just be able to run `npm install` and then `npm start` to get up and running.  Set your `PORT` environment variable to change the port it listens on.
+
+## Improve me
+
+Feel free to add a chaching layer, improve the styles and add more features.