Skip to content

Instantly share code, notes, and snippets.

@oza

oza/msgpack.org.md

Created August 17, 2013 07:50
Show Gist options
  • Save oza/6255786 to your computer and use it in GitHub Desktop.
Save oza/6255786 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
msgpack.org.md

What's this?

This document describes how to add API document of msgpack-related project to top page of msgpack.org.

How to add the API document

  1. Please add the sentence msgpack.org[ProjctName] into Description of yoru github repository.
  2. Please add the document named as follows at root of github repository.
  • msgpack.org.md
  • README.md
  • README.markdown
  • README.rdoc
  • README.rst
  • README

The priority to show at msgpack.org is msgpack.org.md >README.md > README.markdown > README.rdoc > README.rst > README. You can choose to show msgpack.org.md at msgpack.org separately from README.md at your github page. 3. Please wait a moment. A crawler visits your github repository each hour, and it's update msgpack.org page automatically.

Tutorial

This section describes how to update msgpack.org page with an example of msgpack-java.

  1. Add msgpack.org[Java] into Description of msgpack-java.
  2. Add msgpack.org.md into msgpack-java.
  3. Please wait a moment. A crawler visits your github repository each hour, and it's update msgpack.org page automatically.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment