|
35 | 35 | <img src="https://cloud.githubusercontent.com/assets/1699357/21510721/556f650c-cc97-11e6-8a69-ddd67eeeebb8.png" width="250" /> |
36 | 36 | </div> |
37 | 37 | <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 @manekinekko/angular-web-bluetooth @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> |
46 | 45 | <h2 id="1-import-the-webbluetoothmodule-module">1) import the <code>WebBluetoothModule</code> module</h2> |
47 | 46 | <div><pre class="line-numbers"><code class="language-typescript">import { NgModule } from '@angular/core'; |
48 | 47 | import { WebBluetoothModule } from '@manekinekko/angular-web-bluetooth'; |
@@ -164,22 +163,15 @@ <h2 id="1-import-the-webbluetoothmodule-module">1) import the <code>WebBluetooth |
164 | 163 | ) |
165 | 164 | } |
166 | 165 | }</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> |
168 | 167 | <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"/> |
170 | 169 |
|
171 | 170 | <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> |
181 | 173 | <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> |
183 | 175 | <h1 id="license">License</h1> |
184 | 176 | <p>The MIT License (MIT) Copyright (c) 2017 - Wassim CHEGHAM</p> |
185 | 177 | <p>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:</p> |
|
0 commit comments