Update README.md!

onsen-ui · Aug 9, 2017 · 7b1fb79 · 7b1fb79
1 parent b14d9f5
commit 7b1fb79
Show file tree

Hide file tree

Showing 15 changed files with 104 additions and 65 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,26 @@
-# mstdn
+# mstdn-api
 [![Build Status](https://travis-ci.org/onsen-ui/mstdn.svg?branch=master)](https://travis-ci.org/onsen-ui/mstdn)
+[![Coverage Status](https://coveralls.io/repos/github/onsen-ui/mstdn/badge.svg?branch=master)](https://coveralls.io/github/onsen-ui/mstdn?branch=master)
 
-Mastodon API Library
+Mastodon API Library for Node, Browser(ES5), and TypeScript!
+[Github repository](https://github.com/onsen-ui/mstdn)
+[npm package](https://www.npmjs.com/package/mstdn-api) is available.
+
+# Why mstdn-api?
+You can use this library **universally**: Node, Browser, and TypeScript.
+
+# How to use
+There are simple examples in ./example.
+
+# CDN
+from [rawgit.com](https://rawgit.com/)
+[for development](https://rawgit.com/onsen-ui/mstdn/master/dist/mastodon.min.js)
+
+# Documents
+see ./docs/classes/_mastodon_.mastodon.html
+from rawgit
+[documents of class Mastodon](https://rawgit.com/onsen-ui/mstdn/master/docs/classes/_mastodon_.mastodon.html)
+
+# Contributing
+Feel free to contact me.
+Welcome to blush my English and the code up.
diff --git a/docs/classes/_eventstream_.eventstream.html b/docs/classes/_eventstream_.eventstream.html
@@ -261,7 +261,7 @@ <h3>_write</h3>
 							<aside class="tsd-sources">
 								<p>Overrides Writable._write</p>
 								<ul>
-									<li>Defined in eventstream.ts:15</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/eventstream.ts#L15">eventstream.ts:15</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>

diff --git a/docs/classes/_mastodon_.mastodon.html b/docs/classes/_mastodon_.mastodon.html
@@ -129,7 +129,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in mastodon.ts:23</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/mastodon.ts#L23">mastodon.ts:23</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -166,7 +166,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> NO_<wbr>REDIRECT</h3>
 					<div class="tsd-signature tsd-kind-icon">NO_<wbr>REDIRECT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;NO_REDIRECT</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in mastodon.ts:18</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/mastodon.ts#L18">mastodon.ts:18</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -176,7 +176,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> Scope</h3>
 					<div class="tsd-signature tsd-kind-icon">Scope<span class="tsd-signature-symbol">:</span> <a href="../modules/_scope_.scope.html" class="tsd-signature-type">Scope</a><span class="tsd-signature-symbol"> =&nbsp;Scope</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in mastodon.ts:17</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/mastodon.ts#L17">mastodon.ts:17</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -193,7 +193,7 @@ <h3>del</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in mastodon.ts:159</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/mastodon.ts#L159">mastodon.ts:159</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -224,7 +224,7 @@ <h3>get</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in mastodon.ts:134</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/mastodon.ts#L134">mastodon.ts:134</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -263,7 +263,7 @@ <h3>post</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in mastodon.ts:147</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/mastodon.ts#L147">mastodon.ts:147</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -302,7 +302,7 @@ <h3>stream</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in mastodon.ts:173</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/mastodon.ts#L173">mastodon.ts:173</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -341,7 +341,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> fetch<wbr>Access<wbr>Toke
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in mastodon.ts:90</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/mastodon.ts#L90">mastodon.ts:90</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -396,7 +396,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> get</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in mastodon.ts:42</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/mastodon.ts#L42">mastodon.ts:42</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -441,7 +441,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> register<wbr>App</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in mastodon.ts:61</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/mastodon.ts#L61">mastodon.ts:61</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/_oauth_.oauth.appdata.html b/docs/classes/_oauth_.oauth.appdata.html
@@ -132,7 +132,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in oauth.ts:25</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L25">oauth.ts:25</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -169,7 +169,7 @@ <h3>client_<wbr>id</h3>
 					<div class="tsd-signature tsd-kind-icon">client_<wbr>id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in oauth.ts:31</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L31">oauth.ts:31</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -179,7 +179,7 @@ <h3>client_<wbr>secret</h3>
 					<div class="tsd-signature tsd-kind-icon">client_<wbr>secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in oauth.ts:32</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L32">oauth.ts:32</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -189,7 +189,7 @@ <h3>id</h3>
 					<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in oauth.ts:27</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L27">oauth.ts:27</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -199,7 +199,7 @@ <h3>name</h3>
 					<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in oauth.ts:28</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L28">oauth.ts:28</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -209,7 +209,7 @@ <h3>redirect_<wbr>uri</h3>
 					<div class="tsd-signature tsd-kind-icon">redirect_<wbr>uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in oauth.ts:30</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L30">oauth.ts:30</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -219,7 +219,7 @@ <h3>url</h3>
 					<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in oauth.ts:25</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L25">oauth.ts:25</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -229,7 +229,7 @@ <h3>website</h3>
 					<div class="tsd-signature tsd-kind-icon">website<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in oauth.ts:29</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L29">oauth.ts:29</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -246,7 +246,7 @@ <h3>client<wbr>Id</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in oauth.ts:46</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L46">oauth.ts:46</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -263,7 +263,7 @@ <h3>client<wbr>Secret</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in oauth.ts:49</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L49">oauth.ts:49</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -280,7 +280,7 @@ <h3>redirect<wbr>Uri</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in oauth.ts:43</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L43">oauth.ts:43</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -300,7 +300,7 @@ <h3>generate<wbr>Url</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in oauth.ts:58</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L58">oauth.ts:58</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -335,7 +335,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in oauth.ts:39</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L39">oauth.ts:39</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/_oauth_.oauth.tokendata.html b/docs/classes/_oauth_.oauth.tokendata.html
@@ -129,7 +129,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in oauth.ts:71</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L71">oauth.ts:71</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -160,7 +160,7 @@ <h3>_scope</h3>
 					<div class="tsd-signature tsd-kind-icon">_scope<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in oauth.ts:71</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L71">oauth.ts:71</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -170,7 +170,7 @@ <h3>access_<wbr>token</h3>
 					<div class="tsd-signature tsd-kind-icon">access_<wbr>token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in oauth.ts:73</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L73">oauth.ts:73</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -180,7 +180,7 @@ <h3>created_<wbr>at</h3>
 					<div class="tsd-signature tsd-kind-icon">created_<wbr>at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in oauth.ts:76</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L76">oauth.ts:76</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -190,7 +190,7 @@ <h3>token_<wbr>type</h3>
 					<div class="tsd-signature tsd-kind-icon">token_<wbr>type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in oauth.ts:74</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L74">oauth.ts:74</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -207,7 +207,7 @@ <h3>access<wbr>Token</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in oauth.ts:92</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L92">oauth.ts:92</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -229,7 +229,7 @@ <h3>created<wbr>At</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in oauth.ts:104</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L104">oauth.ts:104</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -251,7 +251,7 @@ <h3>scope</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in oauth.ts:98</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L98">oauth.ts:98</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">"read"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"write"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"follow"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h4>
@@ -268,7 +268,7 @@ <h3>token<wbr>Type</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in oauth.ts:95</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L95">oauth.ts:95</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -288,7 +288,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> from</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in oauth.ts:85</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/oauth.ts#L85">oauth.ts:85</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/classes/_streamlistener_.streamlistener.html b/docs/classes/_streamlistener_.streamlistener.html
@@ -142,7 +142,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in streamlistener.ts:26</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/streamlistener.ts#L26">streamlistener.ts:26</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -236,7 +236,7 @@ <h3>close</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in streamlistener.ts:59</li>
+									<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/streamlistener.ts#L59">streamlistener.ts:59</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/enums/_streamlistener_.readystate.html b/docs/enums/_streamlistener_.readystate.html
@@ -92,7 +92,7 @@ <h3>CLOSED</h3>
 					<div class="tsd-signature tsd-kind-icon">CLOSED<span class="tsd-signature-symbol">:</span> </div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in streamlistener.ts:11</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/streamlistener.ts#L11">streamlistener.ts:11</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -102,7 +102,7 @@ <h3>CONNECTING</h3>
 					<div class="tsd-signature tsd-kind-icon">CONNECTING<span class="tsd-signature-symbol">:</span> </div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in streamlistener.ts:9</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/streamlistener.ts#L9">streamlistener.ts:9</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -112,7 +112,7 @@ <h3>OPEN</h3>
 					<div class="tsd-signature tsd-kind-icon">OPEN<span class="tsd-signature-symbol">:</span> </div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in streamlistener.ts:10</li>
+							<li>Defined in <a href="https://github.com/onsen-ui/mstdn/blob/b14d9f5/src/streamlistener.ts#L10">streamlistener.ts:10</a></li>
 						</ul>
 					</aside>
 				</section>