Skip to content

Commit

Permalink
Updates to README
Browse files Browse the repository at this point in the history
  • Loading branch information
charleshearn committed Feb 24, 2016
1 parent dd37b26 commit c7b5b98
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,16 @@ The one API to rule them all
1. Install Node and NPM
2. `npm install` in the project root
3. `npm run local` to start the server
4. You should be good!

Note: you may need API keys to run other people's APIs locally, get them from the maintainer if you're interested

## What you should do

1. Fork this repo
2. Create a new file under `contributors` with your name
3. Add an endpoint that does whatever you think is cool or interesting
4. Make sure to follow good API practices (validation, proper HTTP codes, error handling, etc.)
5. Submit a pull request to this repo to merge your fork.
6. Let us know via email and we'll do a code review with our engineers!

Hopefully this is easier for you and more indicative of skill/ engineering zeal than doing a whiteboarding interview.

0 comments on commit c7b5b98

Please sign in to comment.