Skip to content

Commit ae35244

Browse files
committed
Update Readme.md
1 parent 37b246f commit ae35244

8 files changed

+25
-24
lines changed

Readme.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ A [OneNote](https://www.microsoft.com/en-gb/microsoft-365/onenote/digital-note-t
1515

1616
- [Installation](#installation)
1717
- [Features](#features)
18-
- [At a glance](#at-a-glance)
18+
- [At a Glance](#at-a-glance)
1919
- [Default Search](#default-search)
2020
- [Notebook Explorer](#notebook-explorer)
2121
- [Create New Items](#create-new-items)
@@ -24,7 +24,7 @@ A [OneNote](https://www.microsoft.com/en-gb/microsoft-365/onenote/digital-note-t
2424
- [Title Search](#title-search)
2525
- [Settings](#settings)
2626
- [Keywords](#keywords)
27-
- [Changelog](#200---2023-mm-dd)
27+
- [Changelog](#200---2023-10-05)
2828
- [Acknowledgements](#acknowledgements)
2929

3030
## Installation
@@ -36,11 +36,11 @@ pm install OneNote
3636
```
3737

3838
> [!IMPORTANT]
39-
> For [version 2.0+](#200---2023-mm-dd) requires at Flow Launcher version 1.16+.
39+
> For [version 2.0+](#200---2023-10-05) requires at Flow Launcher version 1.16+. For earlier versions see [releases](https://github.com/Odotocodot/Flow.Launcher.Plugin.OneNote/releases).
4040
4141
## Features
4242

43-
### At a glance
43+
### At a Glance
4444

4545
| Keyword | Name | Description |
4646
| -------------------------- | --------------------------------------- | ---------------------------- |
@@ -72,29 +72,29 @@ This is allows you to search OneNote pages using the OneNote API which searches
7272
> [!NOTE]
7373
> You can include bitwise operators like `AND` or `OR` (they must be uppercase) in your search. E.g. `on hello there AND general kenobi`.
7474
75-
![default search gif]()
75+
![default search gif](doc/default_search.gif)
7676

7777
### Notebook Explorer
7878

7979
```
8080
on nb:\
8181
```
8282

83-
Transverse your OneNote notebooks explorer style.
83+
Traverse your OneNote notebooks explorer style.
8484

8585
- Press <kbd>⏎ Enter</kbd> or <kbd>⇥ Tab</kbd> or left-click on a result to auto complete the query.
8686
- Press <kbd>⇧ Shift</kbd> + <kbd>⏎ Enter</kbd> or right-click on a result to open it directly in OneNote.
8787

88-
![notebook explorer gif]()
88+
![notebook explorer gif](doc/notebook_explorer.gif)
8989

9090
> [!NOTE]
9191
> Supports all OneNote hierarchy items i.e. notebooks, section groups, sections and pages.
9292
9393
#### Create New Items
9494

95-
Whilst using the notebook explorer, if you search query does not match any names of the items in the results, the plugin will give you an option to create a new item.
95+
Whilst using the notebook explorer, if your search query does not match any names of the items in the results, the plugin will give you an option to create a new item.
9696

97-
![create new section gif]()
97+
![create new item gif](doc/create_new_items.gif)
9898

9999
> [!NOTE]
100100
> Supports all OneNote hierarchy items i.e. notebooks, section groups, sections and pages.
@@ -109,7 +109,7 @@ Displays your recently modified OneNote pages.
109109

110110
Add a number after `` rcntpgs: `` to display that number of recent pages. E.g. the full query ``on rcntpgs:10`` will show the 10 most recently modified pages.
111111

112-
![recent pages gif]()
112+
![recent pages gif](doc/recent_pages.gif)
113113

114114
### Scoped Search
115115

@@ -122,7 +122,7 @@ Scoped search is the same as [default search](#default-search) but restricted to
122122
> [!IMPORTANT]
123123
> Must be used with [notebook explorer](#notebook-explorer).
124124
125-
![scoped search gif]()
125+
![scoped search gif](doc/scoped_search.gif)
126126

127127
<details>
128128
<summary><h4>Example Queries<h4></summary>
@@ -146,7 +146,8 @@ Searches for hierarchy items based on their title alone. Unlike [scoped search](
146146
> [!NOTE]
147147
> Can be used in conjunction with [notebook explorer](#notebook-explorer).
148148
149-
![title search gif]()
149+
![title search gif](doc/title_search_default.gif)
150+
![title search gif](doc/title_search_notebook.gif)
150151

151152
<details>
152153
<summary><h4>Example Queries<h4></summary>
@@ -161,7 +162,7 @@ Searches for hierarchy items based on their title alone. Unlike [scoped search](
161162

162163
## Settings
163164

164-
The plugin has a number of settings such as the ability items in the recycle bin or indicate which pages have unread changes.
165+
The plugin has a number of settings such as the ability to hide the recycle bin or indicate which pages have unread changes.
165166

166167
<details>
167168
<summary>Screenshot of settings</summary>
@@ -181,32 +182,32 @@ All the keywords used can be changed according to user preference.
181182
<summary><h2 id="changelog">2.0.0 Changelog: Massive Refactor and New Features</h2></summary>
182183

183184
<!-- omit from toc -->
184-
### 2.0.0 - 2023-mm-dd
185+
### 2.0.0 - 2023-10-05
185186

186187
<!-- omit from toc -->
187188
#### Added
188189

189-
- **[Created custom OneNote parser/library](https://github.com/Odotocodot.OneNote.Linq)** Adding the ability for several new features.
190+
- **[Created custom OneNote parser/library](https://github.com/Odotocodot/Odotocodot.OneNote.Linq)**, adding the ability for several new features.
190191
- Support for section groups when using the notebook explorer.
191192
- Support for displaying unread results.
192193
- Support for showing locked sections in results (you still can't see inside them unless they are unlocked).
193194
- The ability to search by only title.
194195
- The ability to do a scoped search (e.g. search in one section only).
195196
- **Settings!** You can change these options:
196-
- Show unread icons
197-
- Show encrypted sections
198-
- Show recycle bin items
199-
- Created coloured icons for notebook and sections
197+
- Show unread icons.
198+
- Show encrypted sections.
199+
- Show recycle bin items.
200+
- Created coloured icons for notebook and sections.
200201
- Default number of recent pages
201202
- **Customisable keywords!**
202203

203204
<!-- omit from toc -->
204205
#### Changed
205206

206-
- Compressed all images
207-
- Reduced the calls to create a OneNote COM object, this should lead to a overall smoother experience
208-
- Updated to .NET 7 (update Flow Launcher if an error persists)
209-
- Refactored most of the code.
207+
- Compressed images.
208+
- Reduced the calls to create a OneNote COM object, this should lead to a overall smoother experience.
209+
- Updated to .NET 7 (update Flow Launcher if an error persists).
210+
- Refactored majority of code and project structure.
210211

211212
<!-- omit from toc -->
212213
#### Removed
@@ -217,6 +218,6 @@ All the keywords used can be changed according to user preference.
217218

218219
## Acknowledgements
219220

220-
- Made with [Odotocodot.OneNote.Linq](https://github.com/Odotocodot.OneNote.Linq) a library for exposing the OneNote API also made by me :smiley:
221+
- Made with [Odotocodot.OneNote.Linq](https://github.com/Odotocodot/Odotocodot.OneNote.Linq) a library for exposing the OneNote API also made by me :smiley:
221222
- Inspired by the OneNote plugin for [PowerToys](https://github.com/microsoft/PowerToys/tree/main/src/modules/launcher/Plugins/Microsoft.PowerToys.Run.Plugin.OneNote)
222223
- Icons from [Icons8](https://icons8.com)

doc/create_new_items.gif

4.24 MB
Loading

doc/default_search.gif

3.32 MB
Loading

doc/notebook_explorer.gif

3.74 MB
Loading

doc/recent_pages.gif

1.33 MB
Loading

doc/scoped_search.gif

2.4 MB
Loading

doc/title_search_default.gif

1.01 MB
Loading

doc/title_search_notebook.gif

1.57 MB
Loading

0 commit comments

Comments
 (0)