diff --git a/README.md b/README.md index 31e59f2..05f1dc7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,26 @@ # 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 two binaries via npm: `squeebot` and `squeebotd`. @@ -87,4 +109,4 @@ Use `-d dev` to deploy this. ``` ## 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//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//repository.json` by using the `repository install` command. diff --git a/package.json b/package.json index 69a9d1f..322ccb8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@squeebot/cli", - "version": "3.5.0", + "version": "3.5.1", "description": "Squeebot v3 runtime, environments and configuration", "main": "dist/squeebot.js", "bin": { @@ -16,7 +16,7 @@ }, "repository": { "type": "git", - "url": "git+https://gitlab.icynet.eu/Squeebot/cli.git" + "url": "git+https://git.icynet.eu/Squeebot/cli.git" }, "author": "Evert \"Diamond\" Prants ", "license": "MIT",