Merge branch 'master' of https://github.com/windingwind/Notero

README.md

@@ -6,8 +6,7 @@ Knowledge management for Zotero!
 
 ## Install
 
-- Download the latest release (.xpi file) from the [Releases Page](https://github.com/windingwind/zotero-pdf-translate/releases)  
-  _Note_ If you're using Firefox as your browser, right-click the `.xpi` and select "Save As.."
+- Download the latest release (.xpi file) from the [Releases Page](https://github.com/windingwind/zotero-pdf-translate/releases)_Note_ If you're using Firefox as your browser, right-click the `.xpi` and select "Save As.."
 - In Zotero click `Tools` in the top menu bar and then click `Addons`
 - Go to the Extensions page and then click the gear icon in the top right.
 - Select `Install Add-on from file`.
@@ -15,15 +14,82 @@ Knowledge management for Zotero!
 - Restart Zotero, by clicking `restart now` in the extensions list where the
   Zotero PDF Translate plugin is now listed.
 
+## Introduction
+
+**Note**: an atomized **note** including a point, or a method described in a paper, or your thoughts while reading the paper, or anything else you drew from a paper.
+
+A note in Zotero looks something like this (below), with quote sentences and your own thoughts.
+
+![](image/README/1651892918746.png)
+
+**Knowledge**: Simply, knowledge = note**s**.
+
+![](image/README/1651895948057.png)
+
+**Knowledge Workspace**: a place to manage your **notes** in a hierarchical outline.
+
+![](image/README/1651896006854.png)
+
 ## Usage
 
+### Set a new knowledge
+
+After the plugin installtion, click the menu on the top panel to "create new knowledge workspace" to set a new knowledge.
+
+Or, switch the main knowledge to another existing knowledge
+
+![img](image/README/1651896159066.png)
+
+![](image/README/1651896602114.png)
+
+### Add note to knowledge
+
+select some sentences you interested (1) and add to pdf annotation (2);
+
+put some thoughts when you are reading these sentences and add to the certain place of knowledge (3 - 5);
+
+![](image/README/1651897206384.png)
+
+Add an existing note to your knowledge
+
+![](image/README/1651898023847.png)
+
+### Manage your knowledge
+
+Open your main knowledge
+
+![](image/README/1651898106681.png)
+
+manage your notes after you added from pdf annotation
+
+![](image/README/1651897924046.png)
+
+### Backlinks
+
+Go back to the paper from your knowledge (bi-directional links or backlinks).
+
+Click the note and Zotero link, back to the paper when you need (this is my favorite part).
+
+![img](image/README/1651898254827.png)
+
+### Outline mindmap
+
+Click the switch outline mode to see the mindmap
+
+![](image/README/1651900109443.png)
+
+Click the button again to switch outline mode
+
+![](image/README/1651900283206.png)
+
+
 ## Development & Contributing
 
 This add-on is built on the Zotero Addon Template of [zotero-pdf-translate](https://github.com/windingwind/zotero-pdf-translate).
 
 ## Disclaimer
 
-Use this code under AGPL(open source required). No warranties are provided. Keep the laws of your locality in mind!
+Use this code under AGPL (open source required). No warranties are provided. Keep the laws of your locality in mind!
 
 Part of the code of this repo refers to other open-source projects within the allowed scope.