Update readme

Liamballin · Oct 31, 2020 · f9839ef · f9839ef
1 parent c32b84c
commit f9839ef
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 4 deletions.
diff --git a/docs/serverSettings.png b/docs/serverSettings.png
diff --git a/extension/icons/android-chrome-192x192.png b/extension/icons/android-chrome-192x192.png
diff --git a/readme.md b/readme.md
@@ -10,3 +10,23 @@ Until Obsidian supports adding new notes through their custom `Obsidian://` URL
 
 Inspired by jplattel's [Obsidian clipper](https://github.com/jplattel/obsidian-clipper) - a much less janky solution. 
 
+## Usage
+
+With the node server running, clicking the extension icon will save the current page as a markdown bookmark. 
+
+Any selected text or images will be included in the note.
+
+
+## Installation
+
+- Chrome extension:
+
+    Open `chrome://extensions` and select `load unpacked`. Select the extension folder. 
+
+- Node server:
+
+    Running ObsidianBookmark.exe will open the server settings. 
+
+    ![settings](docs/serverSettings.png)
+
+    On starting the server, the app will minimize to the tray and can be accessed from there.
diff --git a/server/index.html b/server/index.html
@@ -3,7 +3,7 @@
     <link rel="stylesheet" href="index.css">
     <link href="https://unpkg.com/tailwindcss@^1.0/dist/tailwind.min.css" rel="stylesheet">
 
-
+    <title>Obsidian Bookmark server</title>
 
     <script>
          const {ipcRenderer} = require('electron')

diff --git a/server/index.js b/server/index.js
@@ -79,7 +79,7 @@ function createWindow(){
         }
     })
 
-    // win.removeMenu()
+    win.removeMenu()
     // win.webContents.openDevTools()
 
     win.on('minimize',function(event){

diff --git a/server/settings.json b/server/settings.json
@@ -1,6 +1,6 @@
 {
-  "close_to_tray": false,
+  "close_to_tray": true,
   "port": "43110",
   "vault_location": "C:\\Users\\Liam\\Desktop\\obsidianClip\\vault",
-  "save_location": "C:\\Users\\Liam\\Desktop\\obsidianClip\\vault\\Nice new bookmarks"
+  "save_location": "C:\\Users\\Liam\\Desktop\\obsidianClip\\vault\\bookmarks"
 }