diff --git a/README.md b/README.md index 7114fd3a..45dce4c8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ # ReDoc +![travis-ci-status] + Swagger-generated API Reference Documentation + +**Under development** +[Live demo][demo] + +## Running locally +1. Clone repository +`git clone https://github.com/Rebilly/ReDoc.git` +2. Go to the project folder +`cd ReDoc` +3. Install node modules +`npm install` +4. _(optional)_ Replace `demo/swagger.json` with your own schema +5. Start the server +`npm start` +6. Open `http://localhost:9000` + + +[travis-ci-status]: https://travis-ci.org/Rebilly/ReDoc.svg?branch=master "TravisCI Status" +[demo]: http://rebilly.github.io/ReDoc/