Permalink
Browse files

Changed README.md

Signed-off-by: Tsuyoshi Ozawa <ozawa.tsuyoshi@gmail.com>
  • Loading branch information...
1 parent 2e37975 commit 354adf12c545a3b35301c3ea7bb7bf0c4d96d907 @oza oza committed Aug 17, 2013
Showing with 19 additions and 37 deletions.
  1. +19 −37 README.md
View
@@ -2,47 +2,29 @@
This is a code repository for [msgpack.org](http://msgpack.org/) website.
-Modicifications on this repository are published to the website automatically.
+## Publishing the API document at the top page of msgpack.org
+The API document of msgpack-related project at the top page of msgpack.org are generated automatically
+by crawling github repository.
-# Publishing website at &lt;lang&gt;.msgpack.org (for committers)
+### How to add the API document
-MessagePack repository administrators can publish website on http://&lt;lang&gt;.msgpack.org domain.
+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
-(If you didn't yet, please read this article as well: [Updates on the MessagePack Project](https://gist.github.com/2892856))
+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](https://github.com/msgpack/website/blob/master/update-index.rb) visits your github repository each hour, and it's update msgpack.org page automatically.
-## 1. Creating clean "gh-pages" branch
+### Tutorial
- # Use your project name here
- NAME=ruby
-
- # Clone the repository to ./msgpack-<lang>-website directory
- git clone git@github.com:msgpack/msgpack-$NAME.git msgpack-$NAME-website
- cd msgpack-$NAME-website
-
- # Create gh-pages branch
- git checkout --orphan gh-pages
-
- # Remove all files from the old working tree
- rm -rf .
-
-## 2. Adding "CNAME" file to the branch
-
- # Create "CNAME" file which has "<lang>.msgpack.org" line
- echo $NAME.msgpack.org > CNAME
- git add CNAME
-
- # Push the branch to github
- git commit -a -m "GitHub Pages for $NAME.msgpack.org"
- git push -u origin gh-pages
-
-## 3. Confirm the website
-
-Wait several minutes until github finishes to generate the website. Then access to `http://<lang>.msgpack.org/`.
-
-You can use `git clone -b gh-pages` to clone the branch from other computers as following:
-
- git clone git@github.com:msgpack/msgpack-$NAME.git msgpack-$NAME-website -b gh-pages
-
-See http://ruby.msgpack.org and https://github.com/msgpack/msgpack-ruby/tree/gh-pages for an example.
+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.

0 comments on commit 354adf1

Please sign in to comment.