Update README and bump version

Chaoses-Ib · Oct 4, 2022 · 88017e2 · 88017e2
1 parent 5e3f3ea
commit 88017e2
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 37 deletions.
diff --git a/CLI/Properties/AssemblyInfo.cs b/CLI/Properties/AssemblyInfo.cs
@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("0.1.0.0")]
-[assembly: AssemblyFileVersion("0.1.0.0")]
+[assembly: AssemblyVersion("0.2.0.0")]
+[assembly: AssemblyFileVersion("0.2.0.0")]
diff --git a/ContextMenu/Properties/AssemblyInfo.cs b/ContextMenu/Properties/AssemblyInfo.cs
@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("0.1.0.0")]
-[assembly: AssemblyFileVersion("0.1.0.0")]
+[assembly: AssemblyVersion("0.2.0.0")]
+[assembly: AssemblyFileVersion("0.2.0.0")]
diff --git a/Installer/ObsidianShell.aip b/Installer/ObsidianShell.aip
@@ -19,10 +19,10 @@
     <ROW Property="ARPURLINFOABOUT" Value="https://github.com/Chaoses-Ib/ObsidianShell"/>
     <ROW Property="ARPURLUPDATEINFO" Value="https://github.com/Chaoses-Ib/ObsidianShell/releases"/>
     <ROW Property="Manufacturer" Value="Chaoses Ib"/>
-    <ROW Property="ProductCode" Value="1033:{A1545806-A852-46D2-BA0E-F61954C7759E} 2052:{A1545806-A852-46D2-BA0E-F61954C7759E} " Type="16"/>
+    <ROW Property="ProductCode" Value="1033:{E68ADFA6-A721-4A05-ADEF-9D2146ABA7F7} 2052:{E68ADFA6-A721-4A05-ADEF-9D2146ABA7F7} " Type="16"/>
     <ROW Property="ProductLanguage" Value="1033"/>
     <ROW Property="ProductName" Value="ObsidianShell"/>
-    <ROW Property="ProductVersion" Value="0.1.0.0" Options="16"/>
+    <ROW Property="ProductVersion" Value="0.2.0.0" Options="16"/>
     <ROW Property="SecureCustomProperties" Value="OLDPRODUCTS;AI_NEWERPRODUCTFOUND;AI_SETUPEXEPATH;SETUPEXEDIR"/>
     <ROW Property="UpgradeCode" Value="{B2C93D0A-14C9-4F42-BFCA-208C5C5F9DCA}"/>
     <ROW Property="WindowsType9X" MultiBuildValue="DefaultBuild:Windows 9x/ME" ValueLocId="-"/>
@@ -70,6 +70,7 @@
     <ROW File="ObsidianCLI.exe.Config" Component_="ObsidianCLI.exe.Config" FileName="OBSIDI~1.CON|ObsidianCLI.exe.Config" Attributes="0" SourcePath="bin\ObsidianCLI.exe.Config" SelfReg="false"/>
     <ROW File="ObsidianContextMenu.dll" Component_="ObsidianContextMenu.dll" FileName="OBSIDI~1.DLL|ObsidianContextMenu.dll" Attributes="0" SourcePath="bin\ObsidianContextMenu.dll" SelfReg="dotNetComInterop"/>
     <ROW File="SharpShell.dll" Component_="SharpShell.dll" FileName="SHARPS~1.DLL|SharpShell.dll" Attributes="0" SourcePath="bin\SharpShell.dll" SelfReg="false"/>
+    <ROW File="ObsidianShell.url" Component_="ObsidianCLI.exe.Config" FileName="OBSIDI~1.URL|ObsidianShell.url" Attributes="0" SourcePath="bin\ObsidianShell.url" SelfReg="false"/>
   </COMPONENT>
   <COMPONENT cid="caphyon.advinst.msicomp.BootstrOptComponent">
     <ROW BootstrOptKey="GlobalOptions" DownloadFolder="[AppDataFolder][|Manufacturer]\[|ProductName]\prerequisites" Options="2"/>

diff --git a/README.md b/README.md
@@ -2,22 +2,23 @@
 Languages: [English](README.md), [简体中文](README.zh-Hans.md)
 
 ## Features
-- Open Markdown files in Obsidian through command line
 - Associate Markdown files with Obsidian  
-  This enables you to integrate Obsidian into your workflow. For example, you can use your favorite launcher to open your notes.
+  In addition to making it easy to open notes, associating files helps integrate Obsidian into your workflows. For example, you can use a launcher to quickly open notes.
 
   For Chinese users:  
   配合支持拼音搜索的启动器，还可以间接实现通过拼音搜索笔记文件，比如：
   - [Everything](https://www.voidtools.com/) + [IbEverythingExt](https://github.com/Chaoses-Ib/IbEverythingExt)
   - [Listary](https://www.listarypro.com/)
-
-- Open standalone Markdown files in Obsidian, i.e., use Obsidian as a Markdown editor (VaultRecent/Recent mode)
-- Enable the *global vault pattern*, which means that you only need to maintain one config for your notes at different locations (Recent mode)
-
+- VaultRecent/Recent mode
+  - Open standalone Markdown files in Obsidian, i.e., use Obsidian as a Markdown editor.
+  - Enable the *global vault pattern*, which means that you can share one config with your notes at different locations.
+- Open Markdown files in Obsidian through command line
 
 ## Installation
 [Releases](https://github.com/Chaoses-Ib/ObsidianShell/releases)
 
+Config file location: `C:\Program Files\Chaoses Ib\ObsidianShell\ObsidianCLI.exe.Config`
+
 ### Set as the default program for Markdown files
 ![](images/File%20list.png)
 
@@ -26,7 +27,6 @@ Languages: [English](README.md), [简体中文](README.zh-Hans.md)
 3. Check `Always use this app to open .md files`
 4. Click `OK`
 
-
 ## CLI
 A command line interface program for opening Markdown files in Obsidian.
 
@@ -36,21 +36,19 @@ It supports three opening modes:
 - VaultRecent  
   If the Markdown file is in a vault, open the vault, otherwise link the file to Recent vault and open the vault.
 
-  This mode is designed to open standalone Markdown files in Obsidian. The idea to implement it comes from [@etienne](https://forum.obsidian.md/t/open-and-edit-standalone-markdown-files/14977).
+  The idea to implement it comes from [@etienne](https://forum.obsidian.md/t/open-and-edit-standalone-markdown-files/14977).
 - Recent  
   Link the Markdown file to Recent vault and open the vault.
 
-  This mode is designed to enable the *global vault pattern*, which means that you only need to maintain one config for your notes at different locations. You can also use Obsidian purely as a Markdown editor. 
-
-You can change the opening mode in `C:\Program Files\Chaoses Ib\ObsidianShell\ObsidianCLI.exe.Config`:
+You can change the opening mode in `ObsidianCLI.exe.Config`:
 ```xml
 <add key="OpenMode" value="VaultFallback" />
 ```
 
 Notice: The vault where the Markdown file in must be in the vault list before opening the file, i.e., you must have opened that vault before, otherwise Obsidian will report an error.
 
 ### Markdown fallback
-You can change the Markdown fallback in `ObsidianCLI.exe.Config`.
+You can change the Markdown fallback editor in `ObsidianCLI.exe.Config`.
 
 Notepad (default):
 ```xml
@@ -76,9 +74,14 @@ You can set the location of your Recent vault in `ObsidianCLI.exe.Config`:
 ```xml
 <add key="RecentVault" value="C:\path\to\Recent" />
 ```
-And the limit of directory number:
+And the maximum number of subdirectories in Recent:
 ```xml
-<add key="RecentNumberLimit" value="10" />
+<add key="RecentLimit" value="10" />
 ```
 
-Notice: You must have opened the Recent vault before, otherwise Obsidian will report an error when opening files.
+Notice: You must have opened the Recent vault before, otherwise Obsidian will report an error when opening files.
+
+## ContextMenu
+![](images/ContextMenu.png)
+
+It is used to open the corresponding directory in Obsidian, complementing the defect that the CLI cannot be associated with directories.
diff --git a/README.zh-Hans.md b/README.zh-Hans.md
@@ -2,23 +2,21 @@
 语言：[English](README.md)、[简体中文](README.zh-Hans.md)
 
 ## 功能
-- 通过命令行在 Obsidian 中打开 Markdown 文件
 - 关联 Markdown 文件到 Obsidian  
-  这有助于将 Obsidian 集成进你的工作流。比如，你可以使用你喜欢的启动器来打开笔记文件。
+  除了方便打开笔记外，关联文件还有助于将 Obsidian 集成进你的工作流，比如你可以使用一个启动器来快速打开笔记文件。
 
   配合支持拼音搜索的启动器，还可以间接实现通过拼音搜索笔记文件，比如：
   - [Everything](https://www.voidtools.com/) + [IbEverythingExt](https://github.com/Chaoses-Ib/IbEverythingExt)
   - [Listary](https://www.listarypro.com/)
-- 在 Obsidian 中打开独立 Markdown 文件，即，把 Obsidian 用作一个 Markdown 编辑器（VaultRecent/Recent 模式）
-- 实现*全局仓库模式*，使得你只需要为在不同位置的笔记维护一份配置（Recent 模式）
-
+- VaultRecent/Recent 模式
+  - 在 Obsidian 中打开独立 Markdown 文件，将 Obsidian 用作一个 Markdown 编辑器
+  - 实现全局仓库模式，让不同位置的笔记可以使用同一份配置
+- 通过命令行在 Obsidian 中打开 Markdown 文件
 
 ## 安装
 [Releases](https://github.com/Chaoses-Ib/ObsidianShell/releases)
 
-要求：
-- [.NET Framework 4.8](https://dotnet.microsoft.com/download/dotnet-framework/net48)（在 Windows 10 1903 及以上默认已安装）
-
+配置文件路径：`C:\Program Files\Chaoses Ib\ObsidianShell\ObsidianCLI.exe.Config`
 ### 设为 Markdown 文件的默认程序
 ![](images/File%20list.png)
 
@@ -27,7 +25,6 @@
 3. 勾选 `始终使用此应用打开 .md 文件`
 4. 点击 `确定`
 
-
 ## CLI
 一个用来在 Obsidian 中打开 Markdown 文件的命令行程序。
 
@@ -37,21 +34,19 @@
 - VaultRecent  
   如果 Markdown 文件在仓库中，打开仓库，否则把它链接到 Recent 仓库并打开。
 
-  这个模式被设计用于在 Obsidian 中打开独立 Markdown 文件。实现方法来自 [@etienne](https://forum.obsidian.md/t/open-and-edit-standalone-markdown-files/14977)。
+  实现方法来自 [@etienne](https://forum.obsidian.md/t/open-and-edit-standalone-markdown-files/14977)。
 - Recent  
   把 Markdown 文件链接到 Recent 仓库并打开。
 
-  这个模式被设计用于实现*全局仓库模式*，使得你只需要为在不同位置的笔记维护一份配置。你也可以把 Obsidian 单纯用作一个 Markdown 编辑器。
-
-打开模式可以在 `C:\Program Files\Chaoses Ib\ObsidianShell\ObsidianCLI.exe.Config` 中设置：
+打开模式可以在 `ObsidianCLI.exe.Config` 中设置：
 ```xml
 <add key="OpenMode" value="VaultFallback" />
 ```
 
 注意：要打开的 Markdown 文件的仓库必须在仓库列表中，也就是说，你必须在之前打开过那个仓库，否则 Obsidian 会报错。
 
 ### Markdown 回落
-Markdown 回落可以在 `ObsidianCLI.exe.Config` 中设置。
+Markdown 回落编辑器可以在 `ObsidianCLI.exe.Config` 中设置。
 
 记事本（默认）：
 ```xml
@@ -77,9 +72,15 @@ Markdown 回落可以在 `ObsidianCLI.exe.Config` 中设置。
 ```xml
 <add key="RecentVault" value="C:\path\to\Recent" />
 ```
-以及目录的最大数量：
+以及 Recent 子目录的最大数量：
 ```xml
 <add key="RecentLimit" value="10" />
 ```
 
-注意：你必须在之前打开过 Recent 仓库，否则 Obsidian 会在打开文件时报错。
+注意：你必须在之前打开过 Recent 仓库，否则 Obsidian 会在打开文件时报错。
+
+## ContextMenu
+上下文菜单：  
+![](images/ContextMenu.png)
+
+用于在 Obsidian 中打开相应目录，补足 CLI 无法关联目录的缺陷。
diff --git a/images/ContextMenu.png b/images/ContextMenu.png