diff --git a/README.md b/README.md
index b4f9343e..98367ea5 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,91 @@
Swagger-generated API Reference Documentation
-**Under development**
-
[Live demo](http://rebilly.github.io/ReDoc/)
+## Deployment
+
+## tl;dr
+```html
+
+
+
+ ReDoc
+
+
+
+
+
+
+
+
+
+
+
+
+```
+
+#### 1. Install redoc
+Install using [bower](bower.io):
+
+ bower install redoc
+
+or using [npm](https://docs.npmjs.com/getting-started/what-is-npm):
+
+ npm install redoc --save
+
+Alternatively you can just download [`redoc.min.js`](https://raw.githubusercontent.com/Rebilly/ReDoc/releases/dist/redoc.min.js).
+
+#### 2. Reference redoc script in HTML
+Then reference [`redoc.min.js`](https://raw.githubusercontent.com/Rebilly/ReDoc/releases/dist/redoc.min.js) in your HTML page:
+```html
+
+```
+For npm:
+```html
+
+```
+
+#### 3. Add `` element to your page
+```html
+
+```
+
+#### 4. Enjoy :smile:
+
+## Configuration
+
+* `spec-url` - relative or absolute url to your spec file
+* `scroll-y-offset` - If set, specifies a vertical scroll-offset. This is often useful when there are fixed positioned elements at the top of the page, such as navbars, headers etc.
+`scroll-y-offset` can be specified in various ways:
+ * **number**: A fixed number of pixels to be used as offset
+ * **selector**: selector of the element to be used for specifying the offset. The distance from the top of the page to the element's bottom will be used as offset.
+ * **function**: A getter function. Must return a number representing the offset (in pixels).
+
+## Advanced usage
+Instead of adding `spec-url` attribute to the `` element you can initialize ReDoc via globally exposed `Redoc` object:
+```js
+Redoc.init(specUrl, options)
+```
+
+`options` is javascript object with camel-cased versions of options names as the keys. For example:
+```js
+Redoc.init('http://petstore.swagger.io/v2/swagger.json', {
+ scrollYOffset: 50
+})
+```
+-----------
## Running locally
1. Clone repository
`git clone https://github.com/Rebilly/ReDoc.git`
diff --git a/bower.json b/bower.json
index f246c497..5e33c388 100644
--- a/bower.json
+++ b/bower.json
@@ -1,7 +1,7 @@
{
"name": "redoc",
"description": "Swagger-generated API Reference Documentation",
- "main": "dist/redoc.full.min.js",
+ "main": "dist/redoc.min.js",
"authors": [
"Roman Hotsiy"
],
diff --git a/build/paths.js b/build/paths.js
index c780902c..06f5c267 100644
--- a/build/paths.js
+++ b/build/paths.js
@@ -3,7 +3,7 @@ module.exports = {
html: 'lib/**/*.html',
scss: 'lib/**/*.scss',
sourceEntryPoint: 'lib/index.js',
- outputName: 'redoc.full',
+ outputName: 'redoc',
output: 'dist/',
tmp: '.tmp/',
demo: 'demo/**/*',
diff --git a/build/tasks/build.js b/build/tasks/build.js
index 0e29efa4..18677e6e 100644
--- a/build/tasks/build.js
+++ b/build/tasks/build.js
@@ -55,7 +55,7 @@ var JS_DEV_DEPS_MIN = [
gulp.task('sass', function () {
return gulp.src(paths.scss, { base: './' })
- .pipe(sass.sync().on('error', sass.logError))
+ .pipe(sass.sync({outputStyle: 'compressed'}).on('error', sass.logError))
.pipe(gulp.dest(paths.tmp));
});
diff --git a/demo/index.html b/demo/index.html
index 89d6f4d2..f7889511 100644
--- a/demo/index.html
+++ b/demo/index.html
@@ -3,21 +3,21 @@
ReDoc
+
+
-
- Loading...
-
+
-
+