From 393de31609fde7f169ee8232831a6cbcea125ed8 Mon Sep 17 00:00:00 2001 From: James Anelay Date: Tue, 16 Apr 2019 17:44:57 +0200 Subject: [PATCH] Add basic start insructions --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7a33a26 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Siren-api-browser +A browser for [Siren](https://github.com/kevinswiber/siren) APIs. + + +# Getting started. + +- Clone this repo +- Navigate to the root of this repo +- Run `yarn install` +- Run `yarn start` (this will start a node js server listening on port 3001. +- Navigate to http://localhost:3001/ +- Enter your Siren API URI & browse.