Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
frsyuki committed Jul 13, 2015
1 parent 9eea594 commit 2bcf9bb
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
11 changes: 5 additions & 6 deletions README.md
Expand Up @@ -2,17 +2,17 @@


This repository manages [msgpack.org website](http://msgpack.org/). This repository manages [msgpack.org website](http://msgpack.org/).


## Publishing your msgpack implementation to msgpack.org ## Publishing your msgpack project to msgpack.org


The list of msgpack implementations on the [msgpack.org website](http://msgpack.org/) is generated automatically. The list of msgpack projects on the [msgpack.org website](http://msgpack.org/) is generated automatically.


[A crawler](https://github.com/msgpack/website/blob/master/update-index.rb) searches Github repositories [A crawler](https://github.com/msgpack/website/blob/master/update-index.rb) searches Github repositories
to find specific repositories and put summary documents to the website. with a specific tag and put their summary to the website.


## How to list up your implementation on msgpack.org ## How to list up your project on msgpack.org


1. Add the keyword ```msgpack.org[ProjctName]``` to description of your github repository 1. Add the keyword ```msgpack.org[ProjctName]``` to description of your github repository
* ```ProjectName``` is typically programming language name such as ```ruby``` * ```ProjectName``` is typically name of a programming language such as ```ruby```
2. Add one of following files to the root directory of your github repository: 2. Add one of following files to the root directory of your github repository:
1. msgpack.org.md 1. msgpack.org.md
2. README.md 2. README.md
Expand All @@ -21,7 +21,6 @@ to find specific repositories and put summary documents to the website.
5. README.rst 5. README.rst
6. README 6. README
3. Wait a moment. [The crawler](https://github.com/msgpack/website/blob/master/update-index.rb) visits your github repository every hour. 3. Wait a moment. [The crawler](https://github.com/msgpack/website/blob/master/update-index.rb) visits your github repository every hour.
4. Your implementation will be listed to the website


The crawler copies content of a file to msgpack.org website. Former file name has priority (```msgpack.org.md``` > ```README.md``` > ...). The crawler copies content of a file to msgpack.org website. Former file name has priority (```msgpack.org.md``` > ```README.md``` > ...).


Expand Down
2 changes: 1 addition & 1 deletion index.html.erb
Expand Up @@ -187,7 +187,7 @@
<h3 class="i18n_head"><%= t 'api' %></h3> <h3 class="i18n_head"><%= t 'api' %></h3>
<h4 id="language">&nbsp;</h4> <h4 id="language">&nbsp;</h4>
<div id="quickstart" class="qsholder"></div> <div id="quickstart" class="qsholder"></div>
<p id="quickstart-guide"><a href="https://github.com/msgpack/website/blob/master/README.md"><%= t 'list_your_impl' %></a></p> <p id="quickstart-guide"><a href="https://github.com/msgpack/website/blob/master/README.md#how-to-list-up-your-project-on-msgpackorg"><%= t 'list_your_impl' %></a></p>


<% repos.each_with_index do |repo,i| %> <% repos.each_with_index do |repo,i| %>
<div id="qs-<%= repo[:msgpack_repo_id] %>" class="qs"><h4><a href="<%= repo[:msgpack_repo_homepage] %>" target="_blank"><%= repo[:full_name] %> <span class="qs-url"><%= repo[:msgpack_repo_homepage] %></span></a></h4> <div id="qs-<%= repo[:msgpack_repo_id] %>" class="qs"><h4><a href="<%= repo[:msgpack_repo_homepage] %>" target="_blank"><%= repo[:full_name] %> <span class="qs-url"><%= repo[:msgpack_repo_homepage] %></span></a></h4>
Expand Down

0 comments on commit 2bcf9bb

Please sign in to comment.