docs(README): Add ReadMe file

This commit is contained in:
2025-08-31 23:51:48 +02:00
parent ae34160b12
commit 421821f1ee

View File

@@ -1,24 +1,48 @@
# CIS Pushover Client
![GitHub License](https://img.shields.io/github/license/cis-oss/pushover)
![NPM Version](https://img.shields.io/npm/v/%40cis-oss%2Fpushover)
![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/cis-oss/pushover?label=bundle%20size)
A client for Pushover, a service for sending notifications. Typesafe.
Supports sending the same message to multiple users.
## Installation
⚠️ This package is **not yet published** to npm.
```bash
pnpm add @cis-oss/pushover
```
<details>
<summary>Or using npm</summary>
```bash
npm install @cis-oss/pushover
```
</details>
<details>
<summary>Or use our meta-packages</summary>
```bash
yarn add @cis-oss/pushover
pnpm add @cis-oss/notify
```
```bash
bun add @cis-oss/pushover
pnpm add @cis-oss/notify-push
```
</details>
# Documentation
Documentation can be found at [https://cis-oss.github.io/pushover](https://cis-oss.github.io/pushover).
# Contributing
Contributions are welcome! Please see [CONTRIBUTING.md](https://github.com/cis-oss/.github/blob/main/CONTRIBUTING.md) for details.
Please make sure to read our [Code of Conduct](https://github.com/cis-oss/.github/blob/main/CODE_OF_CONDUCT.md) and [Support Policy](https://github.com/cis-oss/.github/blob/main/SUPPORT.md).
Disclose security issues responsibly by following our [Security Policy](https://github.com/cis-oss/.github/blob/main/SECURITY.md).