Skip to content

Commit c25e653

Browse files
committed
docs: update api docs
1 parent fe68aa6 commit c25e653

File tree

4 files changed

+20
-30
lines changed

4 files changed

+20
-30
lines changed

docs/dependencies.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,6 @@
7272
<b>@release-it/conventional-changelog</b> : ^1.1.4</li>
7373
<li>
7474
<b>@types/web-bluetooth</b> : 0.0.6</li>
75-
<li>
76-
<b>hammerjs</b> : ^2.0.8</li>
7775
<li>
7876
<b>rxjs</b> : ~6.6.3</li>
7977
<li>

docs/index.html

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,13 @@
3535
<img src="https://cloud.githubusercontent.com/assets/1699357/21510721/556f650c-cc97-11e6-8a69-ddd67eeeebb8.png" width="250" />
3636
</div>
3737
<h2 align="center">The missing Web Bluetooth module for Angular</h2>
38-
<h2 align="center"><img src="https://github.com/manekinekko/angular-web-bluetooth/workflows/Node.js%20CI/badge.svg"/></h2>
39-
40-
<h3 id="yarn-it">Yarn it</h3>
41-
<p><code>yarn add @manekinekko/angular-web-bluetooth @types/web-bluetooth</code></p>
42-
<h3 id="or-npm-it">or NPM it</h3>
43-
<p><code>npm i -S @manekinekko/angular-web-bluetooth @types/web-bluetooth</code></p>
44-
<p>_Note: Make also sure the <code>@types/web-bluetooth</code> is installed correctly in your <code>node_modules</code>. _</p>
45-
<h2 id="use-it">Use it</h2>
38+
<p align="center"><img src="https://github.com/manekinekko/angular-web-bluetooth/workflows/Node.js%20CI/badge.svg"/></p>
39+
40+
<h2 id="install">Install</h2>
41+
<div><pre class="line-numbers"><code class="language-none">npm install -S &#64;manekinekko/angular-web-bluetooth &#64;types/web-bluetooth</code></pre></div><blockquote>
42+
<p>Note: Make also sure the <code>@types/web-bluetooth</code> is installed correctly in your <code>node_modules</code>.</p>
43+
</blockquote>
44+
<h2 id="getting-started">Getting started</h2>
4645
<h2 id="1-import-the-webbluetoothmodule-module">1) import the <code>WebBluetoothModule</code> module</h2>
4746
<div><pre class="line-numbers"><code class="language-typescript">import { NgModule } from &#39;&#64;angular/core&#39;;
4847
import { WebBluetoothModule } from &#39;&#64;manekinekko/angular-web-bluetooth&#39;;
@@ -164,22 +163,15 @@ <h2 id="1-import-the-webbluetoothmodule-module">1) import the <code>WebBluetooth
164163
)
165164
}
166165
}</code></pre></div><h2 id="api-documentation">API documentation</h2>
167-
<p>Here 👉 <a href="https://manekinekko.github.io/angular-web-bluetooth/">https://manekinekko.github.io/angular-web-bluetooth/</a></p>
166+
<p>The API documentation can be found here: <a href="https://manekinekko.github.io/angular-web-bluetooth/">https://manekinekko.github.io/angular-web-bluetooth/</a></p>
168167
<h2 id="need-a-starter">Need a starter?</h2>
169-
<img src="https://cloud.githubusercontent.com/assets/1699357/21523148/b843ceb0-cd0b-11e6-974a-50294a797b27.png"/>
168+
<img src="src/assets/screenshot.png"/>
170169

171170
<p>This project serves also as a starter. Run the following command:</p>
172-
<p><code>npm start</code></p>
173-
<h2 id="blog-post">Blog post</h2>
174-
<p>Checkout my post on medium.</p>
175-
<p align="center">
176-
<a href="https://dev.to/angular/the-web-bluetooth-module-for-angular-314b">
177-
<img src="https://cloud.githubusercontent.com/assets/1699357/21696708/7e33cca4-d38f-11e6-8a03-6833b88e82fa.png" >
178-
</a>
179-
</p>
180-
171+
<div><pre class="line-numbers"><code class="language-bash">npm start</code></pre></div><h2 id="blog-post">Blog post</h2>
172+
<p>Checkout my full <a href="https://dev.to/angular/the-web-bluetooth-module-for-angular-314b">blog post on dev.to</a> about how to use this package in your app.</p>
181173
<h2 id="have-a-pr">Have a PR?</h2>
182-
<p>All contributions are welcome ;)</p>
174+
<p>All contributions are welcome. Here are few <a href="https://github.com/manekinekko/angular-web-bluetooth/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22">open issues</a> that I need help with ;)</p>
183175
<h1 id="license">License</h1>
184176
<p>The MIT License (MIT) Copyright (c) 2017 - Wassim CHEGHAM</p>
185177
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the &quot;Software&quot;), 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:</p>

docs/js/search/search_index.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/miscellaneous/variables.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,10 @@ <h3 id="index">Index</h3>
8989
<a href="#context" title="projects/manekinekko/angular-web-bluetooth/src/test.ts"><b>context</b>&nbsp;&nbsp;&nbsp;(projects/.../test.ts)</a>
9090
</li>
9191
<li>
92-
<a href="#environment" title="src/environments/environment.ts"><b>environment</b>&nbsp;&nbsp;&nbsp;(src/.../environment.ts)</a>
92+
<a href="#environment" title="src/environments/environment.prod.ts"><b>environment</b>&nbsp;&nbsp;&nbsp;(src/.../environment.prod.ts)</a>
9393
</li>
9494
<li>
95-
<a href="#environment" title="src/environments/environment.prod.ts"><b>environment</b>&nbsp;&nbsp;&nbsp;(src/.../environment.prod.ts)</a>
95+
<a href="#environment" title="src/environments/environment.ts"><b>environment</b>&nbsp;&nbsp;&nbsp;(src/.../environment.ts)</a>
9696
</li>
9797
<li>
9898
<a href="#PROVIDERS" title="src/app/thingy52/battery-level.component.ts"><b>PROVIDERS</b>&nbsp;&nbsp;&nbsp;(src/.../battery-level.component.ts)</a>
@@ -537,7 +537,7 @@ <h3></h3> <table class="table table-sm table-bordered">
537537
</tbody>
538538
</table>
539539
</section>
540-
<h3>src/environments/environment.ts</h3>
540+
<h3>src/environments/environment.prod.ts</h3>
541541
<section>
542542
<h3></h3> <table class="table table-sm table-bordered">
543543
<tbody>
@@ -560,7 +560,7 @@ <h3></h3> <table class="table table-sm table-bordered">
560560
<tr>
561561
<td class="col-md-4">
562562
<i>Default value : </i><code>{
563-
production: false
563+
production: true
564564
}</code>
565565
</td>
566566
</tr>
@@ -569,7 +569,7 @@ <h3></h3> <table class="table table-sm table-bordered">
569569
</tbody>
570570
</table>
571571
</section>
572-
<h3>src/environments/environment.prod.ts</h3>
572+
<h3>src/environments/environment.ts</h3>
573573
<section>
574574
<h3></h3> <table class="table table-sm table-bordered">
575575
<tbody>
@@ -592,7 +592,7 @@ <h3></h3> <table class="table table-sm table-bordered">
592592
<tr>
593593
<td class="col-md-4">
594594
<i>Default value : </i><code>{
595-
production: true
595+
production: false
596596
}</code>
597597
</td>
598598
</tr>

0 commit comments

Comments
 (0)