Improve documentation

felt · Jan 30, 2025 · df50c27 · df50c27
1 parent 888a0c8
commit df50c27
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/docs/Tools/README.md b/docs/Tools/README.md
@@ -2,6 +2,23 @@
 
 The Tools part allows you to let users draw elements on the map.
 
+## Example
+
+```ts
+// Change the settings for the line tool
+felt.setToolSettings({
+  tool: "line",
+  strokeWidth: 8,
+  color: "#448C2A"
+});
+
+// Start using the line tool
+felt.setTool("line");
+
+// Put down the tool
+felt.setTool(null);
+```
+
 ## Interfaces
 
 * [PinToolSettings](PinToolSettings.md)

diff --git a/src/modules/tools/index.ts b/src/modules/tools/index.ts
@@ -1,6 +1,22 @@
 /**
  * The Tools part allows you to let users draw elements on the map.
  *
+ * @example
+ * ```ts
+ * // Change the settings for the line tool
+ * felt.setToolSettings({
+ *   tool: "line",
+ *   strokeWidth: 8,
+ *   color: "#448C2A"
+ * });
+ *
+ * // Start using the line tool
+ * felt.setTool("line");
+ *
+ * // Put down the tool
+ * felt.setTool(null);
+ * ```
+ *
  * @module Tools
  */
 export type {