33 lines
813 B
Markdown
33 lines
813 B
Markdown
# 🐰🗜️ pygmyapp/ipc-client
|
|
A simple client library to communicate with a `pygmyapp/ipc-server` instance
|
|
|
|
## Dependencies
|
|
**Pygmy is built with Bun!** It doesn't run on node.js alone, [see here to install Bun](https://bun.com/docs/installation) or [here to learn more](https://bun.sh).
|
|
|
|
## Install
|
|
|
|
### Using package manager
|
|
|
|
```sh
|
|
bun install github:pygmyapp/ipc-client
|
|
```
|
|
|
|
### Manual
|
|
|
|
- Clone this repository
|
|
- Install dependencies with `bun install`
|
|
|
|
You can then build the library:
|
|
```sh
|
|
bun run build
|
|
```
|
|
|
|
## Scripts
|
|
|
|
- `bun run lint`: runs Biome linting, applies safe fixes, and auto-organizes imports
|
|
|
|
## Licence
|
|
Copyright (c) 2025 Pygmy & contributors
|
|
|
|
All code & assets are licensed under GNU GPL v3 unless stated otherwise.
|
|
See `LICENSE` or [see here](https://www.gnu.org/licenses/gpl-3.0.txt). |