GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → square → Pilgrim

square / Pilgrim

Licence: other
A documentation browser for protocol buffers

Programming Languages

javascript
184084 projects - #8 most used programming language

Pilgrim

Pilgrim is a one page application that provides documentation for protocol buffers. It is compiled into a static site by middleman.

DEPRECATED

This project is no longer maintained.

This application does not upload your bundle to the server and relies on CORS to fetch proto bundles.

Creating your own proto bundle

Proto bundles are created with protob.

How to use?

Serve pilgrim/build from your favourite web-server.

To fetch your own proto bundle, use pilgrimize.

  • Create a protos.json file to specify your dependencies
  • Install pilgrimize npm install -g pilgrimize
  • Run pilgrimize in the same directory as your protos.json file

For example. To run your own bundle of the marvel comics api, protos.json:

[
  { "git": "https://github.com/hassox/google-protos.git" },
  { "git": "https://github.com/hassox/fender.git" },
  { "git": "https://github.com/hassox/marvel-protos.git" }
]

Then:

$ npm install -g pilgrimize
$ pilgrimize

Then head over to pilgrim

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].