Skip to content

Commit 54a1381

Browse files
committed
Config
1 parent e6c9d16 commit 54a1381

File tree

2 files changed

+25
-18
lines changed

2 files changed

+25
-18
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,29 @@
11
# wimp
22

3+
A Gleam client for the Pushover push notification API.
4+
35
[![Package Version](https://img.shields.io/hexpm/v/wimp)](https://hex.pm/packages/wimp)
46
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/wimp/)
57

6-
## Quick start
7-
8-
```sh
9-
gleam run # Run the project
10-
gleam test # Run the tests
11-
gleam shell # Run an Erlang shell
12-
```
8+
```gleam
9+
import wimp
10+
import gleam/httpc
1311
14-
## Installation
12+
pub fn send_notification() {
13+
let assert Ok(response) =
14+
wimp.new(token: token, user: user, message: "Hello, Joe!")
15+
|> wimp.message_request
16+
|> httpc.send
1517
16-
If available on Hex this package can be added to your Gleam project:
18+
response
19+
|> wimp.decode_message_response
20+
}
21+
```
1722

1823
```sh
1924
gleam add wimp
2025
```
2126

22-
and its documentation can be found at <https://hexdocs.pm/wimp>.
27+
Code documentation can be found at <https://hexdocs.pm/wimp>.
28+
29+
More information about the Pushover API can be found at <https://pushover.net/api>.

gleam.toml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
name = "wimp"
2-
version = "0.1.0"
2+
version = "1.0.0"
3+
description = "A Gleam client for the Pushover push notification API"
4+
licences = ["Apache-2.0"]
35

4-
# Fill out these fields if you intend to generate HTML documentation or publish
5-
# your project to the Hex package manager.
6-
#
7-
# description = ""
8-
# licences = ["Apache-2.0"]
9-
# repository = { type = "github", user = "username", repo = "project" }
10-
# links = [{ title = "Website", href = "https://gleam.run" }]
6+
repository = { type = "github", user = "lpil", repo = "wimp-pushover" }
7+
links = [
8+
{ title = "Website", href = "https://pushover.net/" },
9+
{ title = "Sponsor", href = "https://github.com/sponsors/lpil" },
10+
]
1111

1212
[dependencies]
1313
gleam_stdlib = "~> 0.31"

0 commit comments

Comments
 (0)