Improve documentation (#9)

.github/workflows/release.yaml

@@ -87,8 +87,9 @@ jobs:
 
             [release]: ${{ steps.create_release.outputs.url }}
 
-      - name: Publish to VS Code Marketplace
-        run: >
-          npx vsce publish
-            --pat "${{ secrets.MARKETPLACE_TOKEN }}"
-            --packagePath "${{ steps.npm_metadata.outputs.name }}-${{ steps.npm_metadata.outputs.version }}.vsix"
+      - name: Publish to Visual Studio Marketplace
+        uses: HaaLeo/publish-vscode-extension@v1
+        with:
+          pat: ${{ secrets.MARKETPLACE_TOKEN }}
+          registryUrl: https://marketplace.visualstudio.com
+          extensionFile: ${{ steps.npm_metadata.outputs.name }}-${{ steps.npm_metadata.outputs.version }}.vsix

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Current
 
+- Improve documentation
+
+# 1.0.3
+
 - Fix changelog
 
 # 1.0.1

README.md

@@ -12,7 +12,52 @@ Language agnostic IDE for VS Code.
 
 ## Configuration
 
-See the _Settings_ section of the _Feature contributions_ tab.
+Alloglot uses the following configuration schema.
+
+```typescript
+type Config = {
+  /**
+   * A command to run in a child process on startup. (TODO)
+   */
+  startCommand: string
+
+  /**
+   * A command to run on shutdown.
+   * `${pid}` will be interpolated with the process ID of the startup process. (TODO)
+   */
+  stopCommand: string
+
+  /**
+   * An array of language configurations.
+   */
+  languages: Array<{
+    /**
+     * The unique language ID.
+     * You can usually find this in a language's syntax-highlighting extension.
+     */
+    languageId: string
+
+    /**
+     * A formatter command.
+     * Reads from STDIN and writes to STDOUT.
+     * `${file}` will be interpolated with the path to the file.
+     */
+    formatCommand: string
+
+    /**
+     * URL to documentation/API search.
+     * `${query}` will be interpolated with the symbol under cursor.
+     */
+    apiSearchUrl: string
+
+    /**
+     * JSON files that will be polled for diagnostics.
+     * See README.md for the format.
+     */
+    annotationsFiles: Array<string>
+  }>
+}
+```
 
 ## Diagnostics JSON format
 

package.json

@@ -2,7 +2,7 @@
   "name": "alloglot",
   "displayName": "Alloglot",
   "description": "Language agnostic IDE for VS Code",
-  "version": "1.0.3",
+  "version": "1.0.1",
   "publisher": "friedbrice",
   "license": "SEE LICENSE IN LICENSE.md",
   "repository": {
@@ -61,6 +61,7 @@
         },
         "alloglot.languages": {
           "type": "array",
+          "description": "An array of language configurations. See README.md.",
           "default": [],
           "items": {
             "type": "object",