/pusher-http-api-reference

Specs for the HTTP API protocol

Primary LanguageJavaScriptMIT LicenseMIT

The Pusher HTTP API Reference

Prerequisites

Ruby

Ruby is required in order to install the asciidoctor gem and to build the protocol documentation.

Editing the Docs

The docs are written in AsciiDoc and generated using Asciidoctor.

To edit the docs simply edit the README.adoc using the AsciiDoc syntax.

Building the Docs

The docs are built using a simple make command. The MakeFile generates the HTML document using Asciidoctor.

From the working directory execute:

make

This will create a http_api.html file which you can then open.