Skip to content

Commit 621ba0f

Browse files
committed
docs: update readme
1 parent c25e653 commit 621ba0f

File tree

2 files changed

+14
-20
lines changed

2 files changed

+14
-20
lines changed

README.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,17 @@
22
<img src="https://cloud.githubusercontent.com/assets/1699357/21510721/556f650c-cc97-11e6-8a69-ddd67eeeebb8.png" width="250" />
33
</div>
44
<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>
66

7-
### Yarn it
7+
## Install
88

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+
```
1412

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`.
1614
17-
## Use it
15+
## Getting started
1816

1917
## 1) import the `WebBluetoothModule` module
2018

@@ -156,29 +154,25 @@ export class BatteryLevelService {
156154

157155
## API documentation
158156

159-
Here 👉 https://manekinekko.github.io/angular-web-bluetooth/
157+
The API documentation can be found here: https://manekinekko.github.io/angular-web-bluetooth/
160158

161159
## Need a starter?
162160

163-
<img src="https://cloud.githubusercontent.com/assets/1699357/21523148/b843ceb0-cd0b-11e6-974a-50294a797b27.png"/>
161+
<img src="src/assets/screenshot.png"/>
164162

165163
This project serves also as a starter. Run the following command:
166164

167-
`npm start`
165+
```bash
166+
npm start
167+
```
168168

169169
## Blog post
170170

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.
178172

179173
## Have a PR?
180174

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 ;)
182176

183177
# License
184178

src/assets/screenshot.png

1.62 MB
Loading

0 commit comments

Comments
 (0)