Permalink
Browse files

updated README.md

  • Loading branch information...
1 parent 9eea594 commit 2bcf9bb5516d2d7d28e80fc59b4a74bf3436547c @frsyuki frsyuki committed Jul 13, 2015
Showing with 6 additions and 7 deletions.
  1. +5 −6 README.md
  2. +1 −1 index.html.erb
View
@@ -2,17 +2,17 @@
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
-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
- * ```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:
1. msgpack.org.md
2. README.md
@@ -21,7 +21,6 @@ to find specific repositories and put summary documents to the website.
5. README.rst
6. README
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``` > ...).
View
@@ -187,7 +187,7 @@
<h3 class="i18n_head"><%= t 'api' %></h3>
<h4 id="language">&nbsp;</h4>
<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| %>
<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>

0 comments on commit 2bcf9bb

Please sign in to comment.