From fcc0bff0ce0991c29f65e7a73ffee9747a0f442c Mon Sep 17 00:00:00 2001 From: hippietrail Date: Thu, 23 Jan 2025 00:58:24 +0800 Subject: [PATCH] update readme --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6ff9015..48da76f 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,25 @@ The **Random File** extension for Visual Studio Code allows you to quickly open ## Features - Open a random file from your workspace. -- Filter files by extensions. -- Excludes files in the `node_modules` directory. +- Filter files by extensions you can specify. +- Excludes files in directories you can also specify. ## Usage - After installing the extension, you can trigger the command by: - Opening the Command Palette (`Cmd+Shift+P` on macOS, `Ctrl+Shift+P` on Windows) and typing `Open a random File`. ## Configuration -You can customize the file extensions that the extension considers by adding the following configuration to your `settings.json`: +You can customize the file extensions that the are considered by modifying the `extensions` option in your `settings.json`: ```json "randomFile.extensions": [".md", ".txt"] ``` +And you can exclude directories by modifying the `excludeDirs` option in your `settings.json`: + +```json +"randomFile.excludeDirs": ["node_modules"] +``` + ## License This project is licensed under the MIT License. \ No newline at end of file