Merge pull request #34 from vslinko/obsidian-commands

1.1.0

README.md

@@ -1,33 +1,116 @@
 # Obsidian Outliner
 
-**Work with your lists like in Workflowy or RoamResearch.**
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/vslinko/obsidian-outliner/Release?logo=github&style=for-the-badge)
+![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/vslinko/obsidian-outliner?style=for-the-badge&sort=semver)
 
-⁉️ Discuss ideas or ask a question in [discussions](https://github.com/vslinko/obsidian-outliner/discussions).<br>
-⚙️ Follow the development process on the [board](https://github.com/vslinko/obsidian-outliner/projects/1).<br>
-🐛 Report bugs in [issues](https://github.com/vslinko/obsidian-outliner/issues).
+**Work with your lists like in Workflowy or RoamResearch**
+
+⁉️ [Discuss ideas or ask a question](https://github.com/vslinko/obsidian-outliner/discussions)<br>
+⚙️ [Follow the development process](https://github.com/vslinko/obsidian-outliner/projects/1)<br>
+🐛 [Report issues](https://github.com/vslinko/obsidian-outliner/issues)
 
 ## Demo
 
 ![Demo](https://raw.githubusercontent.com/vslinko/obsidian-outliner/main/demo.gif)
 
-## Configuration
+## How to install
+
+### From within Obsidian
+
+You can activate this plugin within Obsidian by doing the following:
+
+- Open Settings > Third-party plugin
+- Make sure Safe mode is off
+- Click Browse community plugins
+- Search for "Outliner"
+- Click Install
+- Once installed, close the community plugins window and activate the newly installed plugin
+
+### Manual installation
+
+Download `main.js`, `manifest.json`, `styles.css` from the [latest release](https://github.com/vslinko/obsidian-outliner/releases/latest) and put them into `<vault>/.obsidian/plugins/obsidian-outliner` folder.
+
+## How to use
+
+Try to create a deeply structured list and move items by pressing the hotkeys described below.
+
+## Features
+
+### Improve the style of your lists
+
+If you liked the styles from the demo above, you can enable them in the plugin settings tab.
+
+> **Disclaimer:** Styles are only compatible with built-in Obsidian themes and may not be compatible with other themes. Styles only work well with spaces or four-space tabs.
+
+| Setting                         | Default value |
+| ------------------------------- | :-----------: |
+| Improve the style of your lists |    `false`    |
+
+### Move lists back and forth
+
+Move lists with children wherever you want without breaking the structure.
+
+| Command                       | Default hotkey (Windows/Linux) | Default hotkey (MacOS) |
+| ----------------------------- | :----------------------------: | :--------------------: |
+| Move list and sublists up     |      `Win-Shift-ArrowUp`       |  `Cmd-Shift-ArrowUp`   |
+| Move list and sublists down   |     `Win-Shift-ArrowDown`      | `Cmd-Shift-ArrowDown`  |
+| Indent the list and sublists  |             `Tab`              |         `Tab`          |
+| Outdent the list and sublists |          `Shift-Tab`           |      `Shift-Tab`       |
+
+### Stick the cursor to the content
+
+Don't let the cursor move to the bullet position.
+
+| Setting                         | Default value |
+| ------------------------------- | :-----------: |
+| Stick the cursor to the content |    `true`     |
+
+### Enhance the Enter key
+
+Make the Enter key behave the same as other outliners.
+
+| Setting               | Default value |
+| --------------------- | :-----------: |
+| Enhance the Enter key |    `true`     |
+
+### Fold and unfold your lists
+
+| Command         | Default hotkey (Windows/Linux) | Default hotkey (MacOS) |
+| --------------- | :----------------------------: | :--------------------: |
+| Fold the list   |         `Win-ArrowUp`          |     `Cmd-ArrowUp`      |
+| Unfold the list |        `Win-ArrowDown`         |    `Cmd-ArrowDown`     |
+
+### Select a list item or the entire list
+
+Press the hotkey once to select the current list item. Press the hotkey twice to select the entire list.
+
+| Command                               | Default hotkey (Windows/Linux) | Default hotkey (MacOS) |
+| ------------------------------------- | :----------------------------: | :--------------------: |
+| Select a list item or the entire list |            `Win-a`             |        `Cmd-a`         |
+
+### Zoom in to a specific list item
+
+Hide everything except the list and its children.
+
+![Zoom Demo](https://raw.githubusercontent.com/vslinko/obsidian-outliner/main/demo2.gif)
+
+| Command                          | Default hotkey (Windows/Linux) | Default hotkey (MacOS) |
+| -------------------------------- | :----------------------------: | :--------------------: |
+| Zoom in to the current list item |            `Win-.`             |        `Cmd-.`         |
+| Zoom out the entire document     |         `Win-Shift-.`          |     `Cmd-Shift-.`      |
 
-### Style lists
+### Debug mode
 
-If you liked lists styles from the demo above you can enable it in a plugin settings tab.
+Open DevTools (Command+Option+I or Control+Shift+I) to copy the debug logs.
 
-**Disclaimer:** Lists styles are only compatible with the built-in Obsidian themes and may not be compatible with other themes.
+| Setting    | Default value |
+| ---------- | :-----------: |
+| Debug mode |    `false`    |
 
-## Supported hotkeys
+## Pricing
 
-On Windows/Linux instead of using `Cmd` key use `Ctrl` key.
+This plugin is free for everyone, however, if you would like to thank me
+or help with further development, you can donate in one of the following ways:
 
-- `Tab`, `Shift-Tab` - Change item and subitems indent.
-- `Cmd-ArrowUp`, `Cmd-ArrowDown` - Expand / collapse.
-- `Cmd-Shift-ArrowUp`, `Cmd-Shift-ArrowDown`, - Move item and subitems.
-- `ArrowDown`, `ArrowUp`, `ArrowLeft`, `ArrowRight`, `Cmd-ArrowLeft`, `Cmd-Shift-ArrowLeft` - Move cursor within list content.
-- `Cmd-Backspace` - Delete item content without deleting item.
-- `Backspace` - Delete item.
-- `Enter` - Create new item down below.
-- `Cmd-A` — Select item or whole list.
-- `Cmd-.`, `Cmd-Shift-.` — Zoom-in and zoom-out.
+[![Patreon](https://img.shields.io/badge/patreon-vslinko-orange?logo=patreon&style=social)](https://patreon.com/vslinko)<br>
+[![Paypal](https://img.shields.io/badge/paypal-vslinko-orange?logo=paypal&style=social)](https://www.paypal.me/vslinko)