|
2 | 2 | <img src="https://cloud.githubusercontent.com/assets/1699357/21510721/556f650c-cc97-11e6-8a69-ddd67eeeebb8.png" width="250" /> |
3 | 3 | </div> |
4 | 4 | <h2 align="center">The missing Web Bluetooth module for Angular</h2> |
5 | | -<h2 align="center"><img src="https://github.com/manekinekko/angular-web-bluetooth/workflows/Node.js%20CI/badge.svg"/></h2> |
| 5 | +<p align="center"><img src="https://github.com/manekinekko/angular-web-bluetooth/workflows/Node.js%20CI/badge.svg"/></p> |
6 | 6 |
|
7 | | -### Yarn it |
| 7 | +## Install |
8 | 8 |
|
9 | | -`yarn add @manekinekko/angular-web-bluetooth @types/web-bluetooth` |
10 | | - |
11 | | -### or NPM it |
12 | | - |
13 | | -`npm i -S @manekinekko/angular-web-bluetooth @types/web-bluetooth` |
| 9 | +``` |
| 10 | +npm install -S @manekinekko/angular-web-bluetooth @types/web-bluetooth |
| 11 | +``` |
14 | 12 |
|
15 | | -_Note: Make also sure the `@types/web-bluetooth` is installed correctly in your `node_modules`. _ |
| 13 | +> Note: Make also sure the `@types/web-bluetooth` is installed correctly in your `node_modules`. |
16 | 14 |
|
17 | | -## Use it |
| 15 | +## Getting started |
18 | 16 |
|
19 | 17 | ## 1) import the `WebBluetoothModule` module |
20 | 18 |
|
@@ -156,29 +154,25 @@ export class BatteryLevelService { |
156 | 154 |
|
157 | 155 | ## API documentation |
158 | 156 |
|
159 | | -Here 👉 https://manekinekko.github.io/angular-web-bluetooth/ |
| 157 | +The API documentation can be found here: https://manekinekko.github.io/angular-web-bluetooth/ |
160 | 158 |
|
161 | 159 | ## Need a starter? |
162 | 160 |
|
163 | | -<img src="https://cloud.githubusercontent.com/assets/1699357/21523148/b843ceb0-cd0b-11e6-974a-50294a797b27.png"/> |
| 161 | +<img src="src/assets/screenshot.png"/> |
164 | 162 |
|
165 | 163 | This project serves also as a starter. Run the following command: |
166 | 164 |
|
167 | | -`npm start` |
| 165 | +```bash |
| 166 | +npm start |
| 167 | +``` |
168 | 168 |
|
169 | 169 | ## Blog post |
170 | 170 |
|
171 | | -Checkout my post on medium. |
172 | | - |
173 | | -<p align="center"> |
174 | | - <a href="https://dev.to/angular/the-web-bluetooth-module-for-angular-314b"> |
175 | | - <img src="https://cloud.githubusercontent.com/assets/1699357/21696708/7e33cca4-d38f-11e6-8a03-6833b88e82fa.png" > |
176 | | - </a> |
177 | | -</p> |
| 171 | +Checkout my full [blog post on dev.to](https://dev.to/angular/the-web-bluetooth-module-for-angular-314b) about how to use this package in your app. |
178 | 172 |
|
179 | 173 | ## Have a PR? |
180 | 174 |
|
181 | | -All contributions are welcome ;) |
| 175 | +All contributions are welcome. Here are few [open issues](https://github.com/manekinekko/angular-web-bluetooth/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) that I need help with ;) |
182 | 176 |
|
183 | 177 | # License |
184 | 178 |
|
|
0 commit comments