Squeebot/cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update git stuff

Browse Source
This commit is contained in:
Evert Prants 2022-12-01 15:24:31 +02:00
parent ea1fbd0b8d
commit 3b476e1780
Signed by: evert
GPG Key ID: 1688DA83D222D0B5
2 changed files with 25 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -1,4 +1,26 @@
# Squeebot CLI # Squeebot CLI
Squeebot is a plugin runtime coordinator which, in its original intention, is used to create a multi-platform chat bot.
The core and CLI provide tooling to install, update, execute and coordinate JavaScript plugins.
The plugins all get access to a communication channel - a scoped event emitter - the flow of which can be controlled using channels.
Typically, the plugin repositories providing plugins that connect to a message/event source start with `service-` and the repositories
that provide plugins which do something with the messages/events start with `plugins-`.
```
services channel handlers
+-----+ | +----------+
| IRC | --> | --> | commands | - handles "message" event
+-----+ | +----------+ and resolves it with the response
| /|\
| | the plugin below accesses plugin above's API
| | to register a command
| |
+---------+ | +-----------------+
| Discord | --> | | calendar events |
+---------+ | +-----------------+
```
This package provides the runtime and tooling for Squeebot 3.x.x! This package provides the runtime and tooling for Squeebot 3.x.x!
This package provides two binaries via npm: `squeebot` and `squeebotd`. This package provides two binaries via npm: `squeebot` and `squeebotd`.
@ -87,4 +109,4 @@ Use `-d dev` to deploy this.
``` ```
## Official repositories ## Official repositories
All official repositories [are here](https://gitlab.icynet.eu/Squeebot/official-plugins). Production-ready builds are available to download via Squeebot CLI from `https://squeebot.lunasqu.ee/pkg/<repo name>/repository.json` by using the `repository install` command. All official repositories [are here](https://git.icynet.eu/Squeebot). Production-ready builds are available to download via Squeebot CLI from `https://squeebot.lunasqu.ee/pkg/<repo name>/repository.json` by using the `repository install` command.

4
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "@squeebot/cli", "name": "@squeebot/cli",
"version": "3.5.0", "version": "3.5.1",
"description": "Squeebot v3 runtime, environments and configuration", "description": "Squeebot v3 runtime, environments and configuration",
"main": "dist/squeebot.js", "main": "dist/squeebot.js",
"bin": { "bin": {
@ -16,7 +16,7 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://gitlab.icynet.eu/Squeebot/cli.git" "url": "git+https://git.icynet.eu/Squeebot/cli.git"
}, },
"author": "Evert \"Diamond\" Prants <evert@lunasqu.ee>", "author": "Evert \"Diamond\" Prants <evert@lunasqu.ee>",
"license": "MIT", "license": "MIT",