Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/snow-actions/nostr

Send EVENT to Nostr
https://github.com/snow-actions/nostr

nostr

Last synced: about 1 month ago
JSON representation

Send EVENT to Nostr

Lists

README

        

# snow-actions/nostr

Send EVENT to Nostr.

## Usage

```yml
steps:
- uses: snow-actions/[email protected]
with:
relays: ${{ vars.NOSTR_RELAYS }}
private-key: ${{ secrets.NOSTR_PRIVATE_KEY }}
content: |
Text message
id: publish
- run: echo "${event}"
env:
event: ${{ steps.publish.outputs.event }}
```

Other examples are [`test.yml`](.github/workflows/test.yml).

## Inputs

See [action.yml](action.yml)

| Name | Description | Default | Required |
| - | - | - | - |
| `relays` | Relay URLs `wss://...` (separated by `\n`) | - | yes |
| `private-key` | Private key (nsec or hex) | - | yes |
| `content` | Content | `''` | no |
| `kind` | Kind | `1` | no |
| `tags` | Tags (YAML or JSON) | `[]` | no |

## Outputs

See [action.yml](action.yml)

| Name | Description |
| - | - |
| `event` | Published event |

## Supported

### Runners

- `ubuntu-*`
- `windows-*`
- `macos-*`
- `self-hosted`

### Events

- Any

## Dependencies

- Node.js 16
- See [package.json](package.json)

## Contributing

Welcome.