chore: prepare pigibrack npm package release
This commit is contained in:
50
README.md
Normal file
50
README.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# pigibrack
|
||||
|
||||
Pi package providing a Guile/Scheme structural editing extension.
|
||||
|
||||
## Features
|
||||
|
||||
- Top-level form tools by name:
|
||||
- `pigibrack_read_module`
|
||||
- `pigibrack_read_form`
|
||||
- `pigibrack_replace_form`
|
||||
- `pigibrack_insert_form`
|
||||
- `pigibrack_delete_form`
|
||||
- Syntax checks via Guile reader: `pigibrack_check_syntax`
|
||||
- Persistent Guile REPL sidecar eval: `pigibrack_eval_expr`
|
||||
- Macro expansion: `pigibrack_macro_expand`
|
||||
- Commands:
|
||||
- `/pigibrack-status`
|
||||
- `/pigibrack-repl-reset`
|
||||
|
||||
## Install in pi
|
||||
|
||||
```bash
|
||||
pi install npm:pigibrack
|
||||
```
|
||||
|
||||
Or project-local:
|
||||
|
||||
```bash
|
||||
pi install -l npm:pigibrack
|
||||
```
|
||||
|
||||
## Manual load (this repo)
|
||||
|
||||
Pi auto-discovers `.pi/extensions/pigibrack/index.ts` in this repository.
|
||||
|
||||
## Package manifest
|
||||
|
||||
This package declares:
|
||||
|
||||
```json
|
||||
{
|
||||
"pi": {
|
||||
"extensions": ["./extensions/pigibrack/index.ts"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
BSD-2-Clause.
|
||||
Reference in New Issue
Block a user