Update DESIGN.md; add API section

tshino · Jan 24, 2023 · 8e87a36 · 8e87a36
1 parent b73ec89
commit 8e87a36
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,8 @@ All notable changes to the Keyboard Macro Bata extension will be documented in t
 ### [Unreleased]
 - Update
   - Updated keymap wrapper for Atom Keymap (v3.3.0).
+- Documentation:
+  - Added 'API' section to [DESIGN.md](./DESIGN.md).
 
 ### [0.13.0] - 2023-01-16
 - Feature:

diff --git a/DESIGN.md b/DESIGN.md
@@ -148,6 +148,10 @@ In other examples, the command `kb-macro.abortPlayback` is another type of comma
 
 These command patterns are implemented in [`src/reentrant_guard.js`](src/reentrant_guard.js).
 
+## API
+
+This extension provides an experimental API that other extensions could use to realize custom keyboard automation in a different manner than this extension. [Dynamic Macro](https://marketplace.visualstudio.com/items?itemName=tshino.dynamic-macro) is an extension that uses this API. You can find some details and the background information at [#176](https://github.com/tshino/vscode-kb-macro/issues/176).
+
 ## Testing
 
 This repository contains a set of tests for this extension.