From 12937169edb71bc92a18dd6e8ed81e8e9dd8314d Mon Sep 17 00:00:00 2001 From: d7sd6u <58745001+d7sd6u@users.noreply.github.com> Date: Thu, 6 Mar 2025 16:15:37 +0400 Subject: [PATCH] docs: update README and manifests --- README.md | 23 ++++++++++++----------- package.json | 4 ++-- src/manifest.json | 7 +++++-- 3 files changed, 19 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 3db95e0..6ec351d 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ _Do you know what ftags (clones, symlinks) are? If not, you should definitely check [this](https://github.com/d7sd6u/obsidian-lazy-cached-vault-load?tab=readme-ov-file#wait-a-minute-what-are-folderindex-notes-what-are-ftags-what-do-you-mean-annexed) out._ -Adds several commands to manipulate file's ftags. +Adds several commands to manipulate ftags. ## Commands -- `Remove inbox tag` - removes inbox tag (e.g. `Uncategorized`) from the file +- `Remove inbox tag` - remove inbox tag (e.g. `Uncategorized`) from the file - `Add ftag to note` - add ftag to the note. Removes inbox tag automatically - `Open random inbox item` - open random note that has inbox tag - `Create new note as child` - create new note that has current file as ftag. Converts current file to folder note automatically @@ -14,19 +14,20 @@ Adds several commands to manipulate file's ftags. ## Other plugins -- [lazy-cached-vault-load](https://github.com/d7sd6u/obsidian-lazy-cached-vault-load) - reduce startup time on mobile to 2-3s even with 30k+ notes vault -- [auto-folder-note-paste](https://github.com/d7sd6u/obsidian-auto-folder-note-paste) - makes sure your attachments are "inside" your note on paste and drag'n'drop by making your note a folder note -- [folders-graph](https://github.com/d7sd6u/obsidian-folders-graph) - adds folders as nodes to graph views -- [reveal-folded](https://github.com/d7sd6u/obsidian-reveal-folded) - reveal current file in file explorer while collapsing everything else -- [hide-index-files](https://github.com/d7sd6u/obsidian-hide-index-files) - hide folder notes (index files) from file explorer -- [virtual-dirs](https://github.com/d7sd6u/obsidian-virtual-dirs) - adds "virtual" folder files / folder indexes. You can open them, you can search for them, but they do not take space and "materialise" whenever you want a _real_ folder note +- [lazy-cached-vault-load](https://github.com/d7sd6u/obsidian-lazy-cached-vault-load) - Reduces startup time on mobile to 2-3 seconds, even with a vault containing 30k+ notes. +- [reveal-folded](https://github.com/d7sd6u/obsidian-reveal-folded) - Adds a command that reveals the current file in the file explorer while collapsing all other items. +- [auto-folder-note-paste](https://github.com/d7sd6u/obsidian-auto-folder-note-paste) - Ensures your attachments are placed inside your note when pasting or using drag-and-drop by converting your note into a folder note. +- [folders-graph](https://github.com/d7sd6u/obsidian-folders-graph) - Adds folders as nodes in graph views. +- [hide-index-files](https://github.com/d7sd6u/obsidian-hide-index-files) - Hides folder notes (index files) from the file explorer. +- [crosslink-advanced](https://github.com/d7sd6u/obsidian-crosslink-advanced) - Adds commands for managing [ftags](https://github.com/d7sd6u/obsidian-lazy-cached-vault-load?tab=readme-ov-file#wait-a-minute-what-are-folderindex-notes-what-are-ftags-what-do-you-mean-annexed)-oriented vaults: adding ftags, creating child notes, opening random unftagged file, etc. +- [virtual-dirs](https://github.com/d7sd6u/obsidian-virtual-dirs) - Adds 'virtual' folder files or folder indexes. You can open and search for them, but they do not take up space and 'materialize' whenever you need a real folder note. - [viewer-ftags](https://github.com/d7sd6u/obsidian-viewer-ftags) - add ftags as chips on top of markdown/file editors/previews. And children as differently styled chips too! -- [git-annex-autofetch](https://github.com/d7sd6u/obsidian-git-annex-autofetch) - lets you open annexed but not present files as if they were right on your device (basically, NFS/overlay-fs hybrid in your Obsidian) +- [git-annex-autofetch](https://github.com/d7sd6u/obsidian-git-annex-autofetch) - Allows you to open annexed files that are not locally present as if they were on your device (essentially, an NFS/overlay-fs hybrid in Obsidian). ## Disclamer / Safety -This plugin calls some of the destructive file system APIs (write, move). However it should not make any irreversible changes (only moving files and changing `.symlinks` in notes' frontmatter). That said, always [backup](https://en.wikipedia.org/wiki/Backup#:~:text=3-2-1%20rule) your vault whether you use this plugin or not. +This plugin uses certain file system APIs that can modify files, such as writing and moving them. However, it should not make any irreversible changes, as it only moves files and modifies symlinks in notes' frontmatter. That said, always [back up](https://en.wikipedia.org/wiki/Backup#:~:text=3-2-1%20rule) your vault whether you use this plugin or not. ## Contributing -Issues and patches are welcome. This plugin is intended to be used with other plugins and I would try to do my best to support this use case, but I retain the right to refuse supporting any given plugin for arbitrary reasons. +Issues and patches are welcome. This plugin is designed to work alongside other plugins, and I will do my best to support such use cases. However, I retain the right to refuse support for any given plugin at my discretion. diff --git a/package.json b/package.json index f858fe1..085a189 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "crosslink-advanced", - "version": "0.0.1", + "version": "1.0.0", "description": "", "main": "./src/main.ts", "scripts": { @@ -14,7 +14,7 @@ "format:check": "prettier --check ." }, "keywords": [], - "author": "", + "author": "d7sd6u", "license": "LGPL-3.0-only", "devDependencies": { "@eslint/js": "^9.20.0", diff --git a/src/manifest.json b/src/manifest.json index 57aa204..ce28aa5 100644 --- a/src/manifest.json +++ b/src/manifest.json @@ -3,9 +3,12 @@ "name": "Crosslink Advanced", "version": "1.0.0", "minAppVersion": "0.15.0", - "description": "Allows to tag files using folders and symlinks system.", + "description": "Tag files using folders and symlinks system (ftags).", "author": "d7sd6u", "authorUrl": "https://github.com/d7sd6u", - "fundingUrl": "https://ko-fi.com/d7sd6u", + "fundingUrl": { + "Ko-fi": "https://ko-fi.com/d7sd6ug", + "GitHub Sponsor": "https://github.com/sponsors/d7sd6u" + }, "isDesktopOnly": false }