diff --git a/LICENSE b/LICENSE index 287f37a..9c10de6 100644 --- a/LICENSE +++ b/LICENSE @@ -1,5 +1,21 @@ -Copyright (C) 2020-2025 by Dynalist Inc. +MIT License -Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted. +Copyright (C) 2025 Christ Degni -THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. \ No newline at end of file +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index dd50799..f34ba0d 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,31 @@ Utilize text autocomplete to type more efficiently. -### Features +## Features - A dropdown of suggested words of the currently typed word - Replace the currently typed word with a suggestion from the dropdown by: - Selecting a suggestion with your cursor - Selecting the highlighted suggestion with `enter`/`tab` -- Navigate dropdown suggestions with the `up/down arrows` -- A modifiable custom dictionary on top of the base dictionary of the plugin +- Navigate dropdown suggestions with the `up/down arrows` +- Hide the dropdown with `escape` at which point all keys have their default functionalities +- Also, use the default `enter` functionality by additionally holding shift: `shift + enter` -- Be able to use escape to hide dropdown temporarily until start typing again -- remove dropdown on cursor move that isnt a positive increment (not typing) -- Maybe add right-click add to custom dictionary option +### Custom dictionary -### Custom Dictionary +The custom dictionary is a list of words you curate that is added to the plugin's dictionary. The words from the custom dictionary can then be suggested in future dropdowns. You can view all words in the custom dictionary from the plugin settings. + +#### Modification +- Words can be individually added to the custom dictionary in the following two ways: + - From the plugin settings + - In the context menu of selected text (accessible via `right click`) +- Words can be individually removed from the custom dictionary only from within the plugin settings +- The custom dictionary can be reset in the plugin settings as well +## Additional + +- The maximum number of suggestions is modifiable in the plugin settings (3-10) +- The plugin can be disabled from the plugin settings +- English is the only supported language at the moment +- For the time being, all features are disabled within code blocks (typing within code blocks is not supported) \ No newline at end of file diff --git a/manifest.json b/manifest.json index 8ed0bfd..270af86 100644 --- a/manifest.json +++ b/manifest.json @@ -5,6 +5,7 @@ "minAppVersion": "1.8.10", "description": "Autocomplete text to type more efficiently.", "author": "Christ Degni", - "isDesktopOnly": false, - "css": "styles.css" + "isDesktopOnly": true, + "css": "styles.css", + "fundingUrl": "https://buymeacoffee.com/c.degni" } diff --git a/settings.ts b/settings.ts index 47c7208..04896c6 100644 --- a/settings.ts +++ b/settings.ts @@ -72,7 +72,7 @@ export class TASettingsTab extends PluginSettingTab { // Custom dictionary setting new Setting(containerEl) .setName('Custom dictionary') - .setDesc('Add words to a your own custom dictionary.') + .setDesc('Add words to a your custom dictionary.') .addText(text => { text.setPlaceholder('e.g. tiktok'); text.inputEl.addEventListener('keydown', async (e) => {