Skip to content
This repository was archived by the owner on Sep 28, 2021. It is now read-only.

Commit cc45ce5

Browse files
vasco-santosvasco-santos
committed
chore: update documentation
0 parents  commit cc45ce5

File tree

1 file changed

+91
-0
lines changed

1 file changed

+91
-0
lines changed

‎index.html

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
<!doctype html>
2+
<html><head><meta charset="utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>ipfs-http-response - Documentation</title><link href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,500|Roboto:300,500,700" rel="stylesheet"/><style>body{margin: 0;
3+
padding: 0;
4+
color: #000;
5+
font-family: Roboto, sans-serif;
6+
font-weight: 300;
7+
line-height: 26px;
8+
font-size: 17px;}*{-moz-box-sizing: border-box;
9+
box-sizing: border-box;}</style></head><body><main id="app"><div data-radium="true"><div style="position:fixed;box-shadow:0px 2px 3px 0px rgba(0, 0, 0, 0.25);width:100%;min-width:100%;margin-left:0px;margin-right:0px;height:65px;z-index:99;background:#FFFFFF;padding-top:10px;padding-bottom:10px;padding-left:20px;padding-right:20px;" data-radium="true"><div style="margin-right:auto;margin-left:auto;padding-left:15px;padding-right:15px;" class="rmq-87b609c0 rmq-159a7c96 rmq-27601239" data-radium="true"><div style="margin-left:-15px;margin-right:-15px;" data-radium="true"><div style="position:relative;min-height:1px;padding-left:15px;padding-right:15px;float:left;width:50.00000%;" class="rmq-aa1729d5 rmq-a22eaf97 rmq-1918856d rmq-6156e77b rmq-21ab0466 rmq-a01b93a4 rmq-d226cb7e rmq-5cc71c8" data-radium="true"><svg fill="currentColor" preserveAspectRatio="xMidYMid meet" height="1em" width="1em" viewBox="0 0 40 40" style="vertical-align:inherit;font-size:36px;margin-right:20px;"><g><path d="m30 22.5h-5c-1.3 0-2.5 1.3-2.5 2.5h10c0-1.3-1.2-2.5-2.5-2.5z m-2.1-16.2c-6.6 0-8.2 1.2-9.1 2.1-1-0.9-2.6-2.1-9.2-2.1s-9.6 1.7-9.6 3v22.9c1.1-0.6 4.6-1.9 8.4-2.2 4.4-0.4 9.1 0.4 9.1 1.2 0 0.7 0.3 1.3 1.2 1.3h0.1c0.9 0 1.2-0.6 1.2-1.2 0-0.9 4.6-1.7 9.1-1.3 3.7 0.3 7.3 1.6 8.4 2.2v-22.9c0-1.3-3.1-3-9.6-3z m-10.4 22.3c-1.2-0.6-4-1.1-7.5-1.1s-6.6 0.5-7.5 1.1v-17.3s2.5-2.4 7.5-2.4 7.5 1.1 7.5 2.4v17.3z m17.5 0c-0.9-0.6-4-1.1-7.5-1.1s-6.3 0.5-7.5 1.1v-17.3s2.5-2.4 7.5-2.4 7.5 1.1 7.5 2.4v17.3z m-5-11.1h-5c-1.3 0-2.5 1.3-2.5 2.5h10c0-1.3-1.2-2.5-2.5-2.5z m0-5h-5c-1.3 0-2.5 1.3-2.5 2.5h10c0-1.3-1.2-2.5-2.5-2.5z m-17.5 5h-5c-1.2 0-2.5 1.2-2.5 2.5h10c0-1.2-1.2-2.5-2.5-2.5z m0 5h-5c-1.2 0-2.5 1.2-2.5 2.5h10c0-1.2-1.2-2.5-2.5-2.5z m0-10h-5c-1.2 0-2.5 1.2-2.5 2.5h10c0-1.2-1.2-2.5-2.5-2.5z"></path></g></svg><div style="display:inline-block;" data-radium="true"><div style="text-transform:uppercase;font-family:Roboto, sans-serif;" data-radium="true">ipfs-http-response</div><div style="font-family:Roboto Mono, Menlo, Monaco, Courier, monospace;font-weight:300;" data-radium="true">0.1.2</div></div></div><div style="position:relative;min-height:1px;padding-left:15px;padding-right:15px;float:right !important;width:25.00000%;text-align:right;font-size:36px;" class="rmq-aa1729d5 rmq-a22eaf97 rmq-1918856d rmq-6156e77b rmq-77267d84 rmq-5c0c1446 rmq-4605701c rmq-34ee8e6a" data-radium="true"><a href="https://github.com/ipfs/js-ipfs-http-response#readme"><svg fill="currentColor" preserveAspectRatio="xMidYMid meet" height="1em" width="1em" viewBox="0 0 40 40" style="vertical-align:middle;"><g><path d="m20 0c-11 0-20 9-20 20 0 8.8 5.7 16.3 13.7 19 1 0.2 1.3-0.5 1.3-1 0-0.5 0-2 0-3.7-5.5 1.2-6.7-2.4-6.7-2.4-0.9-2.3-2.2-2.9-2.2-2.9-1.9-1.2 0.1-1.2 0.1-1.2 2 0.1 3.1 2.1 3.1 2.1 1.7 3 4.6 2.1 5.8 1.6 0.2-1.3 0.7-2.2 1.3-2.7-4.5-0.5-9.2-2.2-9.2-9.8 0-2.2 0.8-4 2.1-5.4-0.2-0.5-0.9-2.6 0.2-5.3 0 0 1.7-0.5 5.5 2 1.6-0.4 3.3-0.6 5-0.6 1.7 0 3.4 0.2 5 0.7 3.8-2.6 5.5-2.1 5.5-2.1 1.1 2.8 0.4 4.8 0.2 5.3 1.3 1.4 2.1 3.2 2.1 5.4 0 7.6-4.7 9.3-9.2 9.8 0.7 0.6 1.4 1.9 1.4 3.7 0 2.7 0 4.9 0 5.5 0 0.6 0.3 1.2 1.3 1 8-2.7 13.7-10.2 13.7-19 0-11-9-20-20-20z"></path></g></svg></a></div><div style="clear:both;" data-radium="true"></div></div><div style="clear:both;" data-radium="true"></div></div></div><div style="margin-right:auto;margin-left:auto;padding-left:15px;padding-right:15px;padding-top:104px;" class="rmq-87b609c0 rmq-159a7c96 rmq-27601239" data-radium="true"><div style="margin-left:-15px;margin-right:-15px;" data-radium="true"><div style="position:fixed;min-height:1px;padding-left:15px;padding-right:15px;float:left;width:8.33333%;height:80%;max-width:300px;" class="rmq-aa1729d5 rmq-a22eaf97 rmq-1918856d rmq-6156e77b rmq-5c4c5b38 rmq-5c0c1446 rmq-4605701c rmq-34ee8e6a rmq-35757987 rmq-f09e82ae" data-radium="true"><div style="font-family:Roboto, sans-serif;border-radius:4px;padding-top:0;padding-bottom:0;margin-top:26px;border:1px solid #e6e9ed;font-weight:500;font-size:15px;line-height:18px;max-height:70vh;overflow-x:auto;" data-radium="true"><ul style="list-style:none;margin-top:0;margin-bottom:0;padding-left:0;" data-radium="true"><div data-radium="true"><li style="padding-left:20px;padding-right:20px;padding-top:13px;padding-bottom:13px;border-bottom:none;" data-radium="true"><a style="color:#000;" href="#intro" data-radium="true">Intro</a></li></div></ul></div></div><div style="position:relative;min-height:1px;padding-left:15px;padding-right:15px;float:left;width:100.00000%;" class="rmq-aa1729d5 rmq-a22eaf97 rmq-1918856d rmq-6156e77b rmq-89bb2272 rmq-2d0e68c6 rmq-3752549c rmq-3b9282ea rmq-4d29a8df rmq-ea7683a5 rmq-ad95cc33" data-radium="true"><div class="content" data-radium="true"><style>h1, h2, h3, h4, h5, h6{font-family: Roboto, sans-serif;
10+
font-weight: 300;}h1{font-size: 48px;
11+
line-height: 72px;}h2{font-size: 24px;
12+
line-height: 36px;}h3{font-size: 19px;
13+
line-height: 29px;
14+
font-weight: 400;}h4{font-size: 17px;
15+
line-height: 22px;
16+
font-weight: 400;}a{text-decoration: none;
17+
color: #00AAFF;
18+
:hover: [object Object];}a.anchor:before{content: "";
19+
display: block;
20+
height: 100px;
21+
margin: -80px 0 0;}.content blockquote{padding-left: 20px;
22+
margin: 0;
23+
border-left: 4px solid #eee;}.content ul, content li{list-style: none;}.content ul li:before{color: #CCC;
24+
float: left;
25+
margin-left: -20px;
26+
margin-top: 1px;
27+
content: "•";}pre.hljs, pre > code{margin-bottom: 30px;
28+
font-family: Roboto Mono, Menlo, Monaco, Courier, monospace;
29+
padding: 12px 15px 12px 15px;
30+
border-radius: 4px;
31+
box-shadow: inset 0 0 0 1px rgba(0, 0, 0, 0.1);
32+
display: block;
33+
position: relative;
34+
overflow-x: auto;
35+
font-size: 13px;
36+
color: #666;
37+
white-space: pre;}code{font-family: Roboto Mono, Menlo, Monaco, Courier, monospace;
38+
display: inline;
39+
font-size: 13px;
40+
font-weight: 400;
41+
margin: 0 2px;
42+
padding: 1px 6px;
43+
box-shadow: 0 0 0 1px #DDD;
44+
white-space: nowrap;
45+
border-radius: 4px;}.hljs{display: block;
46+
overflow-x: auto;}.hljs-comment, .hljs-quote{color: #998;
47+
font-style: italic;}.hljs-keyword, .hljs-selector-tag, .hljs-subst{color: #333;
48+
font-weight: bold;}.hljs-number, .hljs-literal, .hljs-variable, .hljs-template-variable, .hljs-tag .hljs-attr{color: #008080;}.hljs-string, .hljs-doctag{color: #d14;}.hljs-title, .hljs-section, .hljs-selector-id{color: #900;
49+
font-weight: bold;}.hljs-subst{font-weight: normal;}.hljs-type, .hljs-class .hljs-title{color: #458;
50+
font-weight: bold;}.hljs-tag, .hljs-name, .hljs-attribute{color: #000080;
51+
font-weight: normal;}.hljs-regexp, .hljs-link{color: #009926;}.hljs-symbol, .hljs-bullet{color: #990073;}.hljs-built_in, .hljs-builtin-name{color: #0086b3;}.hljs-meta{color: #999;
52+
font-weight: bold;}.hljs-deletion{background: #fdd;}.hljs-addition{background: #dfd;}.hljs-emphasis{font-style: italic;}.hljs-strong{font-weight: bold;}</style><div style="margin-bottom:104px;" data-radium="true"><h1 data-radium="true"><a class="anchor" name="intro"></a>Intro</h1><div><p>Installable via <code>npm install --save ipfs-http-response</code>, it can also be used directly in the browser.</p>
53+
<h2>Download</h2>
54+
<p>The source is available for download from <a href="git+https://github.com/ipfs/js-ipfs-http-response.git">GitHub</a>. Alternatively, you can install using npm:</p>
55+
<pre class='hljs'>$ npm install --save ipfs-http-response</pre>
56+
<p>You can then <code>require()</code> ipfs-http-response as normal:</p>
57+
<pre class='hljs'><span class="hljs-keyword">const</span> ipfsHttpResponse = <span class="hljs-built_in">require</span>(<span class="hljs-string">'ipfs-http-response'</span>)</pre>
58+
<h2>In the Browser</h2>
59+
<p>Ipfs-http-response should work in any ES2015 environment out of the box.</p>
60+
<p>Usage:</p>
61+
<pre class='hljs'><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"text/javascript"</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"index.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span></pre>
62+
<p>The portable versions of ipfs-http-response, including <code>index.js</code> and <code>index.min.js</code>, are included in the <code>/dist</code> folder. Ipfs-http-response can also be found on <a href="https://unpkg.com">unkpkg.com</a> under</p>
63+
<ul>
64+
<li><a href="https://unpkg.com/ipfs-http-response/dist/index.min.js">https://unpkg.com/ipfs-http-response/dist/index.min.js</a></li>
65+
<li><a href="https://unpkg.com/ipfs-http-response/dist/index.js">https://unpkg.com/ipfs-http-response/dist/index.js</a></li>
66+
</ul>
67+
</div></div></div></div><div style="clear:both;" data-radium="true"></div></div><div style="clear:both;" data-radium="true"></div></div><style>@media (min-width: 768px) and (max-width: 991px){ .rmq-87b609c0{width: 750px !important;}}
68+
@media (min-width: 992px) and (max-width: 1199px){ .rmq-159a7c96{width: 970px !important;}}
69+
@media (min-width: 1200px){ .rmq-27601239{width: 1170px !important;}}
70+
@media (min-width: 480px) and (max-width: 767px){ .rmq-aa1729d5{float: left !important;}}
71+
@media (min-width: 768px) and (max-width: 991px){ .rmq-a22eaf97{float: left !important;}}
72+
@media (min-width: 992px) and (max-width: 1199px){ .rmq-1918856d{float: left !important;}}
73+
@media (min-width: 1200px){ .rmq-6156e77b{float: left !important;}}
74+
@media (min-width: 480px) and (max-width: 767px) { .rmq-21ab0466{width: 50.00000% !important;}}
75+
@media (min-width: 768px) and (max-width: 991px) { .rmq-a01b93a4{width: 50.00000% !important;}}
76+
@media (min-width: 992px) and (max-width: 1199px) { .rmq-d226cb7e{width: 50.00000% !important;}}
77+
@media (min-width: 1200px) { .rmq-5cc71c8{width: 50.00000% !important;}}
78+
@media (min-width: 480px) and (max-width: 767px) { .rmq-77267d84{width: 25.00000% !important;}}
79+
@media (min-width: 768px) and (max-width: 991px) { .rmq-5c0c1446{width: 25.00000% !important;}}
80+
@media (min-width: 992px) and (max-width: 1199px) { .rmq-4605701c{width: 25.00000% !important;}}
81+
@media (min-width: 1200px) { .rmq-34ee8e6a{width: 25.00000% !important;}}
82+
@media (min-width: 480px) and (max-width: 767px) { .rmq-5c4c5b38{width: 8.33333% !important;}}
83+
@media (max-width: 479px){ .rmq-35757987{display: none !important;}}
84+
@media (min-width: 480px) and (max-width: 767px) { .rmq-f09e82ae{display: none !important;}}
85+
@media (min-width: 480px) and (max-width: 767px) { .rmq-89bb2272{width: 100.00000% !important;}}
86+
@media (min-width: 768px) and (max-width: 991px) { .rmq-2d0e68c6{width: 66.66667% !important;}}
87+
@media (min-width: 992px) and (max-width: 1199px) { .rmq-3752549c{width: 66.66667% !important;}}
88+
@media (min-width: 1200px) { .rmq-3b9282ea{width: 66.66667% !important;}}
89+
@media (min-width: 768px) and (max-width: 991px) { .rmq-4d29a8df{left: 33.33333% !important;}}
90+
@media (min-width: 992px) and (max-width: 1199px) { .rmq-ea7683a5{left: 33.33333% !important;}}
91+
@media (min-width: 1200px) { .rmq-ad95cc33{left: 33.33333% !important;}}</style></div></main></body></html>

0 commit comments

Comments
 (0)