From acd5ea7eb5445aa4bed5bb25a690d98660c2f02d Mon Sep 17 00:00:00 2001 From: Snazzah Date: Sat, 19 Dec 2020 22:39:40 +0000 Subject: [PATCH] chore(docs): auto-update docs --- docs/general/changelog.md | 21 ++++++++++++++++++++- docs/general/welcome.md | 5 +++-- 2 files changed, 23 insertions(+), 3 deletions(-) diff --git a/docs/general/changelog.md b/docs/general/changelog.md index cc7eb069..96f43508 100644 --- a/docs/general/changelog.md +++ b/docs/general/changelog.md @@ -5,6 +5,24 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +## [1.2.0] - 2020-12-19 +### Changed: +- `ctx.options` are a bit more consistent with sub-commands. Check the [last heading in the documetation](#/docs/main/v1.2.0/general/context-options) for an example. +### Added: +- Support for registering/unregistering commands + - New `SlashCreator` event: `commandUnregister` + - New `SlashCreator` event: `commandReregister` + - `SlashCreator.reregisterCommand(command, oldCommand)` + - `SlashCreator.unregisterCommand(command)` + - `SlashCommand.reload()` + - `SlashCommand.unload()` +- Unknown Commands +- [Support for Google Cloud Functions](https://slash-create.js.org/#/docs/main/v1.2.0/examples/gcf). (`GCFServer`) +### Fixed: +- Some documentation +- Command finalization +- Command throttling +- Command options validation ## [1.1.6] - 2020-12-18 ### Fixed: - Sending options as the first argument in `Context#send` & `Context#sendFollowUp` @@ -89,7 +107,7 @@ This release features mostly completed documentation and changes to the packages ## [0.1.0] - 2020-12-15 - Initial release. -[Unreleased]: https://github.com/Snazzah/slash-create/compare/v1.1.6...HEAD +[Unreleased]: https://github.com/Snazzah/slash-create/compare/v1.2.0...HEAD [0.1.0]: https://github.com/Snazzah/slash-create/releases/tag/v0.1.0 [0.2.0]: https://github.com/Snazzah/slash-create/compare/v0.1.0...v0.2.0 [1.0.0]: https://github.com/Snazzah/slash-create/compare/v0.2.0...v1.0.0 @@ -100,3 +118,4 @@ This release features mostly completed documentation and changes to the packages [1.1.4]: https://github.com/Snazzah/slash-create/compare/v1.1.3...v1.1.4 [1.1.5]: https://github.com/Snazzah/slash-create/compare/v1.1.4...v1.1.5 [1.1.6]: https://github.com/Snazzah/slash-create/compare/v1.1.5...v1.1.6 +[1.2.0]: https://github.com/Snazzah/slash-create/compare/v1.1.6...v1.2.0 diff --git a/docs/general/welcome.md b/docs/general/welcome.md index 739eec5e..0d4864c3 100644 --- a/docs/general/welcome.md +++ b/docs/general/welcome.md @@ -28,7 +28,8 @@ yarn add slash-create In order to use a specific webserver, you will need to install the dependency associated with that server. The following server types require these dependencies: - `ExpressServer`: `express` - `FastifyServer`: `fastify` -- `GatewayServer`: none, see [example](#using-a-discord-bot-with-create) +- `GatewayServer`: none, see [example](#/docs/main/latest/examples/discord-bot) +- `GCFServer`: none technically, meant for use with [`@google-cloud/functions-framework`](https://npm.im/@google-cloud/functions-framework), see [example](https://slash-create.js.org/#/docs/main/latest/examples/gcf) ## Example @@ -117,7 +118,7 @@ module.exports = class HelloCommand extends SlashCommand { ## Useful Links - [**Discord Documentation on Slash Commands**](https://discord.com/developers/docs/interactions/slash-commands) - [Website](https://slash-create.js.org/) ([source](https://github.com/Snazzah/slash-create-website)) -- [Documentation](#/docs/main/latest/general/welcome) +- [Documentation](https://slash-create.js.org/#/docs/main/latest/general/welcome) - [Commands Template](https://github.com/Snazzah/slash-create-template) - [GitHub](https://github.com/Snazzah/slash-create) - [NPM](https://www.npmjs.com/package/slash-create)