diff --git a/README.md b/README.md index d84436a..80f663b 100644 --- a/README.md +++ b/README.md @@ -1 +1,22 @@ # Obsidian Node Factor +This plugin helps you customize the factors that effect node size in obsidian graph view. +The factors include, letter count, forward & backward weight, and forward tree weight. + + +## Installation +1. Search for "Node Factor" in Obsidian's community plugin browser. +2. Install it. +3. Enable the plugin in your Obsidian settings under "Community plugins". +## Configuration Options +| Option | Meaning | Default value | +| ------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------- | +| Forward link weight multiplier | Weight of single link coming out of a node | 1 | +| Travel forward tree | Determines if forward weight is decided by just the immediate nodes coming out or everything after it | off | +| Backward link weight multiplier | Weight of single link coming out of a node | 1 | +| Character per weight | Given number of letters give 1 weight | 0 | +## Author +CalfMoon: [Email](kritagyabhattarai@proton.me), [Github](https://github.com/CalfMoon) +## Bug Reports +This project still new and might have a few bugs. For bug reports use this repo's Issues section. +## License +OBSD, see [LICENSE](LICENSE). diff --git a/manifest.json b/manifest.json index d8cf197..c3dc15b 100644 --- a/manifest.json +++ b/manifest.json @@ -3,7 +3,7 @@ "name": "Node Factor", "version": "1.0.0", "minAppVersion": "0.15.0", - "description": "Demonstrates some of the capabilities of the Obsidian API.", + "description": "Customize factors effecting node size in graph.", "author": "CalfMoon", "authorUrl": "https://github.com/CalfMoon", "isDesktopOnly": false diff --git a/screenshots/1.jpeg b/screenshots/1.jpeg new file mode 100644 index 0000000..4706de3 Binary files /dev/null and b/screenshots/1.jpeg differ diff --git a/screenshots/2.jpeg b/screenshots/2.jpeg new file mode 100644 index 0000000..8ba0ab7 Binary files /dev/null and b/screenshots/2.jpeg differ