diff --git a/README.md b/README.md index 72397e6..44b1be7 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,58 @@ -# [IWE](https://iwe.md) - Personal Knowledge Management (PKM) system +# [IWE](https://iwe.md) - Markdown notes assistant -![Demo](https://iwe.md/docs/demo.gif) +## Quick demos -# About +#### Exract notes -[IWE](https://iwe.md) is a tool that helps you organize your markdown notes. It treats notes as an interconnected graph, where each document acts as a sub-tree and the links are the edges connecting them. It supports various operations designed to assist with navigating and restructuring the graph. +![Demo](https://iwe.md/images/extract.gif) -The main focus of [IWE](https://iwe.md) is to help you keep your notes organized. It works with the graph at the semantic level, understanding the **headers**, **lists** and **links** defined structure of the documents. +
+Search + +![Demo](https://iwe.md/images/search.gif) + +
+ +
+Normalization + +![Demo](https://iwe.md/images/normalization.gif) + +
+ +## About + +IWE is a tool that helps you organize your markdown notes. It treats notes as an interconnected graph, where each document acts as a sub-tree and the links are the edges connecting them. It supports various operations designed to assist with navigating and restructuring the graph. + +The main focus of IWE is to help you keep your notes tidy and structured. It works with the graph at the semantic level, understanding the **headers**, **lists** and **links** defined structure of the documents. + +IWE allows you to organize notes **hierarchically** using block-references, all without relying on a folder structure, directly within your favorite editor. > [!NOTE] > -> A simple analogy for software engineers would be an IDE for markdown notes. +> A simple analogy for software engineers would be an IDE for Markdown notes. -IWE functions in two modes: +IWE functions in two modes, as editor extension and CLI utility -1. **Editor Extension Mode** (LSP server) +## Editor Extension Mode - IWE integrates seamlessly with your editor, helping you to: +IWE integrates seamlessly with your editor, helping you to: - - Search through your notes - - Navigate through markdown links - - Auto-complete links as you type - - Extract or inline sub-notes seamlessly - - Format the document and refresh link titles - - Rename files and automatically update all related links - - Select backlinks to find references to the current document - - Convert lists into headers and vice versa smoothly - - Display inlay hints with parent note references and link counts +- Search through your notes +- Navigate through markdown links +- Auto-complete links as you type +- Extract or inline sub-notes seamlessly +- Format the document and refresh link titles +- Rename files and automatically update all related links +- Select backlinks to find references to the current document +- Convert lists into headers and vice versa smoothly +- Display inlay hints with parent note references and link counts -2. **Command Line Utility Mode** +Please visit [IWE.md](https://iwe.md) for more information. - This tool lets you process thousands of documents in just a second. With IWE, you can reformat documents and update link titles across your entire library. You can also use the CLI mode to combine multiple files into one extended document. +## Command Line Utility Mode -Please visit [IWE.md](https://iwe.md) for more information. +This tool lets you process thousands of documents in just a second. With IWE, you can reformat documents and update link titles across your entire library. You can also use the CLI mode to combine multiple files into one extended document. ## Get Involved