doc/file.README.html in simple2ch-0.0.1 vs doc/file.README.html in simple2ch-0.0.2
- old
+ new
@@ -60,36 +60,49 @@
</div>
<iframe id="search_frame"></iframe>
<div id="content"><div id='filecontents'>
-<h1 id="label-Ruby2ch">Ruby2ch</h1>
+<h1 id="label-Simple2ch">Simple2ch</h1>
-<p>TODO: Write a gem description</p>
+<p>2ch Japanese BBS simple reader.</p>
<h2 id="label-Installation">Installation</h2>
<p>Add this line to your application's Gemfile:</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ruby2ch</span><span class='tstring_end'>'</span></span></code></pre>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>simple2ch</span><span class='tstring_end'>'</span></span></code></pre>
<p>And then execute:</p>
<pre class="code ruby"><code class="ruby">$ bundle</code></pre>
<p>Or install it yourself as:</p>
-<pre class="code ruby"><code class="ruby">$ gem install ruby2ch</code></pre>
+<pre class="code ruby"><code class="ruby">$ gem install simple2ch</code></pre>
<h2 id="label-Usage">Usage</h2>
+<ul><li>
+<p>初期化 <code>ruby require 'simple2ch' </code></p>
+</li><li>
+<p>スレ取得 <code>ruby board = Simple2ch::Board.new('ニュー速VIP',
+'http://viper.2ch.sc/news4vip/') board.thres
+#=>[#<Simple2ch::Thre>, ..., #<Simple2ch::Thre>] </code></p>
+</li><li>
+<p>レス取得 <code>ruby thre = board.thres[hoge] #=> #<Simple2ch::Thre>
+thre.reses #=> [#<Simple2ch::Res>, ..., #<Simple2ch::Res>]
+</code></p>
+</li><li>
+<p>書き込み内容取得 <code>ruby res = thre.reses[foo] #=> #<Simple2ch::Res>
+res.author #=> "以下、＼(^o^)／でVIPがお送りします" res.contents #=>
+"hoge foo bar" </code></p>
+</li></ul>
-<p>TODO: Write usage instructions here</p>
-
<h2 id="label-Contributing">Contributing</h2>
<ol><li>
<p>Fork it ( <a
-href="https://github.com/[my-github-username]/ruby2ch/fork">github.com/[my-github-username]/ruby2ch/fork</a>
+href="https://github.com/dogwood008/simple2ch/fork">github.com/dogwood008/simple2ch/fork</a>
)</p>
</li><li>
<p>Create your feature branch (<code>git checkout -b my-new-feature</code>)</p>
</li><li>
<p>Commit your changes (<code>git commit -am 'Add some
@@ -100,10 +113,10 @@
<p>Create a new Pull Request</p>
</li></ol>
</div></div>
<div id="footer">
- Generated on Sun Sep 7 11:29:29 2014 by
+ Generated on Sun Sep 7 16:55:25 2014 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.4 (ruby-2.1.2).
</div>
</body>
\ No newline at end of file