diff --git a/README.md b/README.md index 46e0fe0..c917dc4 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,16 @@ # Obsidian Bulk Rename Plugin -**Note:** The Obsidian API is still in early alpha and is subject to change at any time! +## Introduction -# Introduction +This plugin was developed to cover my initial needs and rename a bunch of files and update their reference in code base respectively. So now you can rename a bunch of files from the directory and all imports also will be updated in a code-base -This plugin was developed to cover my initial needs and rename a bunch of files -and update their reference in code base respectively. -So now you can rename a bunch of files from the directory -and all imports also will be updated in a code-base - - -# How to use? +## How to use? - **folder location** - Files from which folder you need to rename -- **Symbols in existing files** - the symbols/characters that we have in the files in that particular directory +- **Symbols in existing files** - the symbols/characters that we have in the files - **Replacement Symbols** - a new symbols that will be pasted instead - **Files within the folder** - this is for information purpose +## Installing +The plugin in beta. To beta test, you can install the plugin using BRAT (see [BRAT > Adding a beta plugin](https://github.com/TfTHacker/obsidian42-brat#adding-a-beta-plugin) for further instructions). diff --git a/main.ts b/main.ts index b6b87c3..6caa4a3 100644 --- a/main.ts +++ b/main.ts @@ -155,12 +155,12 @@ class BulkRenameSettingsTab extends PluginSettingTab { renderRenameFiles() { const desc = document.createDocumentFragment(); desc.append( - 'You are going to update all marked files', + 'You are going to update all marked files and their directories', desc.createEl('br'), desc.createEl('b', { text: 'Warning: ', }), - 'This plugin in ALPHA, make sure you checked all files in preview', + 'This plugin in Beta, make sure you verified all files in preview', ); new Setting(this.containerEl)