Skip to content

Commit 1afccab

Browse files
committed
docs: update README
1 parent 6a4ec29 commit 1afccab

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,31 @@ Simple web push for Elixir
77

88
## Installation
99

10-
The package can be installed by adding `web_push_elixir` to your list of dependencies in `mix.exs`:
10+
1. The package can be installed by adding `web_push_elixir` to your list of dependencies in `mix.exs`:
1111

1212
```elixir
1313
def deps do
1414
[
1515
{:web_push_elixir, "~> 0.1.0"}
1616
]
1717
end
18-
```
18+
```
19+
20+
2. Run the mix command to generate your Vapid public and private keys:
21+
22+
```commandline
23+
mix generate.vapid.keys
24+
```
25+
26+
3. Set your environment variables for your keys:
27+
28+
```yaml
29+
environment:
30+
- VAPID_PUBLIC_KEY=someVapidPublicKey
31+
- VAPID_PRIVATE_KEY=someVapidPrivateKey
32+
- VAPID_SUBJECT=mailto:[email protected]
33+
```
34+
35+
## Credits
36+
37+
Heavily inspired by [@danhper](https://github.com/danhper) as his work on [elixir-web-push-encryption](https://github.com/danhper/elixir-web-push-encryption) :pray: Thank you

0 commit comments

Comments
 (0)