Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
malinowskip committed Apr 28, 2024
1 parent 99239e6 commit a73894e
Showing 3 changed files with 26 additions and 2 deletions.
18 changes: 18 additions & 0 deletions cli.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
/**
* @module
* Command-line utility to send messages to the [Pushover Message
* API](https://pushover.net/api) endpoint.
*
* ## Install
*
* ```shell
* deno install --allow-net -n push jsr:@malinowskip/push/cli
* ```
*
* ## Send a message
*
* ```shell
* push --user <YOUR_USERNAME> --token <YOUR_TOKEN> --message "Hello, world!"
* ```
*/

import { type ArgumentValue, Command } from "jsr:@cliffy/command@1.0.0-rc.4";
import { push, type PushoverMessage } from "./mod.ts";
import packageMeta from "./deno.json" with { type: "json" };
4 changes: 2 additions & 2 deletions deno.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "@malinowskip/push",
"version": "0.1.2",
"version": "0.1.3",
"exports": {
".": "./mod.ts",
"./cli": "./cli.ts"
}
}
}
6 changes: 6 additions & 0 deletions mod.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @module
* Utilities to send messages to the [Pushover Message
* API](https://pushover.net/api) endpoint.
*/

/**
* Based on the [Pushover Message API documentation](https://pushover.net/api).
*/

0 comments on commit a73894e

Please sign in to comment.