Skip to content

Adds some basic getting started instructions. #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Adds some basic getting started instructions. #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
393de31
Add basic start insructions
JamesAnelay Apr 16, 2019
e42a862
Merge pull request #1 from JamesAnelay/readme
JamesAnelay Apr 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.