Skip to content

Commit e42a862

Browse files
authored
Merge pull request #1 from JamesAnelay/readme
Add basic start insructions
2 parents b2e61e0 + 393de31 commit e42a862

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Siren-api-browser
2+
A browser for [Siren](https://github.com/kevinswiber/siren) APIs.
3+
4+
5+
# Getting started.
6+
7+
- Clone this repo
8+
- Navigate to the root of this repo
9+
- Run `yarn install`
10+
- Run `yarn start` (this will start a node js server listening on port 3001.
11+
- Navigate to http://localhost:3001/
12+
- Enter your Siren API URI & browse.

0 commit comments

Comments
 (0)