docs(README): Add ReadMe file
This commit is contained in:
32
README.md
32
README.md
@@ -1,24 +1,48 @@
|
||||
# CIS Pushover Client
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
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).
|
||||
|
||||
Reference in New Issue
Block a user