Browse files

Add README, LICENSE and link to source code

  • Loading branch information...
1 parent df50023 commit 7fc9cf2756b653e85f37dec74d3d8ef9c7724095 @timdream committed Apr 6, 2011
Showing with 67 additions and 2 deletions.
  1. +20 −0 MIT-LICENSE.txt
  2. +43 −0 README.md
  3. +2 −1 en/index.html
  4. +2 −1 zh/index.html
View
20 MIT-LICENSE.txt
@@ -0,0 +1,20 @@
+Copyright (c) 2011 Timothy Guan-tin Chien, http://timc.idv.tw/wordcloud/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
43 README.md
@@ -0,0 +1,43 @@
+HTML5 Word Cloud
+================
+
+Word Cloud on HTML5 canvas, inspired by HTML5 Word Cloud
+================
+
+Word Cloud on HTML5 canvas, inspired by
+[Wordle](http://www.wordle.net/).
+
+Author: Timothy Chien <timdream@gmail.com>
+
+URL: http://timc.idv.tw/wordcloud/
+
+## Intro
+
+HTML5 Word Cloud is inspired by Wrodle, instead of generate the image
+on a Java Applet, this experiment is entirely on HTML5 canvas.
+
+## Under the hood
+
+This program is composed of three libraries, two of them have
+dependency of jQuery thus they are warped as jQuery plug-ins:
+
+1. `jquery.getcontent.js` which access remote or local content though
+ Google Feed API, YQL data.html (experimental), and FileReader API.
+2. `wordfreq.js` which count the phrases/words by running N-gram
+ analysis (for Chinese) and [Porter Stemming Algorithm](http://tartarus.org/~martin/PorterStemmer/)
+ (for English) in Web Workers.
+3. finally, `jquery.wordcloud.js` draw the phrases/words on canvas
+ using configured parameters.
+
+Each of the libraries comes with their own tests/demos and are
+designed to be reusable.
+
+Following external libraries are included:
+
+1. Porter Stemming Algorithm in Javascript as mentioned above.
+2. [Simulated Web Workers](https://github.com/timdream/simworker) (`worker.js`)
+ to provide a simulated web workers interface in IEs and Mobile Safari.
+
+## Q&A
+
+I can be reached by e-mail.
View
3 en/index.html
@@ -111,7 +111,8 @@
<div id="help_panel" class="panel">
<h2>About</h2>
<div class="entry">
- <p>Author: <a href="http://timc.idv.tw/" target="_blank">timdream</a>. Please feel free to leave <a href="http://blog.timc.idv.tw/posts/wordcloud/" target="_blank">comments</a>.</p>
+ <p>Author: <a href="http://timc.idv.tw/" target="_blank">timdream</a>.</p>
+ <p>Feel free to leave <a href="http://blog.timc.idv.tw/posts/wordcloud/" target="_blank">comments</a> or grab the <a href="https://github.com/timdream/wordcloud" target="_blank">source code</a>.</p>
<p>Technologies:</p>
<ul>
<li>Chinese: Self-developed N-gram analyzer</li>
View
3 zh/index.html
@@ -114,7 +114,8 @@
<div id="help_panel" class="panel">
<h2>關於</h2>
<div class="entry">
- <p>作者:<a href="http://timc.idv.tw/" target="_blank">timdream</a>。任何建議歡迎<a href="http://blog.timc.idv.tw/posts/wordcloud/" target="_blank">留言</a>。</p>
+ <p>作者:<a href="http://timc.idv.tw/" target="_blank">timdream</a>。</p>
+ <p>任何建議歡迎<a href="http://blog.timc.idv.tw/posts/wordcloud/" target="_blank">留言</a>。<a href="https://github.com/timdream/wordcloud" target="_blank">源碼</a>以 MIT 授權釋出。</p>
<p>使用技術:</p>
<ul>
<li>中文:自製的 N-gram 演算法</li>

0 comments on commit 7fc9cf2

Please sign in to comment.