Skip to content

Commit 38814ed

Browse files
committed
docs: update README
1 parent 86873df commit 38814ed

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
<div align="center">
2-
<h3>Web Push Elixir</h3>
3-
<p>
4-
<em>Simple web push library for Elixir</em>
5-
</p>
6-
<a href="https://github.com/midarrlabs/web-push-elixir/actions/workflows/test.yml">
7-
<img src="https://github.com/midarrlabs/web-push-elixir/actions/workflows/test.yml/badge.svg" alt="Test Status">
8-
</a>
9-
<a href="https://codecov.io/gh/midarrlabs/web-push-elixir">
10-
<img src="https://codecov.io/gh/midarrlabs/web-push-elixir/branch/main/graph/badge.svg?token=8PJVJG09RK&style=flat-square" alt="Code Coverage">
11-
</a>
12-
<a href="https://hex.pm/packages/web_push_elixir">
13-
<img alt="Hex Version" src="https://img.shields.io/hexpm/v/web_push_elixir.svg">
14-
</a>
15-
<a href="https://hexdocs.pm/web_push_elixir">
16-
<img alt="Hex Docs" src="http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat">
17-
</a>
18-
</div>
19-
20-
### Prerequisities
1+
2+
# Web Push Elixir
3+
<p>
4+
<em>Simple web push library for Elixir</em>
5+
</p>
6+
<a href="https://github.com/midarrlabs/web-push-elixir/actions/workflows/test.yml">
7+
<img src="https://github.com/midarrlabs/web-push-elixir/actions/workflows/test.yml/badge.svg" alt="Test Status">
8+
</a>
9+
<a href="https://codecov.io/gh/midarrlabs/web-push-elixir">
10+
<img src="https://codecov.io/gh/midarrlabs/web-push-elixir/branch/main/graph/badge.svg?token=8PJVJG09RK&style=flat-square" alt="Code Coverage">
11+
</a>
12+
<a href="https://hex.pm/packages/web_push_elixir">
13+
<img alt="Hex Version" src="https://img.shields.io/hexpm/v/web_push_elixir.svg">
14+
</a>
15+
<a href="https://hexdocs.pm/web_push_elixir">
16+
<img alt="Hex Docs" src="http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat">
17+
</a>
18+
19+
20+
## Prerequisities
2121

2222
* Elixir 1.15, OTP 24 / 25 / 26
2323

24-
### Installation
24+
## Installation
2525

2626
1. Add `web_push_elixir` to your list of dependencies in `mix.exs`:
2727

@@ -48,7 +48,7 @@ environment:
4848
- VAPID_SUBJECT=mailto:admin@email.com
4949
```
5050
51-
### Usage
51+
## Usage
5252
5353
`WebPushElixir` provides a simple public API `send_notification/2` that accepts 2 arguments:
5454

@@ -65,6 +65,6 @@ WebPushElixir.send_notification(subscription, message)
6565
For more information on how to subscribe a client, permission UX and more - have a look at [https://web.dev/notifications/](https://web.dev/notifications/)
6666

6767

68-
### Credits
68+
## Credits
6969

7070
Heavily inspired by [elixir-web-push-encryption](https://github.com/danhper/elixir-web-push-encryption)

0 commit comments

Comments
 (0)