chore: prepare initial release

florian42 · Jan 21, 2023 · 501ee19 · 501ee19
1 parent 90d67db
commit 501ee19
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,16 @@
 # <img src="public/icons/icon_48.png" width="45" align="left"> Obsidian Clipper
 
-> Obsidian Web Clipper Chrome Extension to save articles and pages from the web in Obsidian
+> The "Obsidian Clipper" Chrome extension allows you to easily save articles from the web as notes in your Obsidian vault. 
 
-## Features
+## Description
 
-- Feature 1
-- Feature 2
+The extension utilizes Readability.js to extract the content of the article, as well as important metadata such as the domain, title, timestamp, excerpt, and word count. This allows you to easily organize and access your saved articles within your Obsidian vault. The extension is simple and easy to use, with a one-click saving feature that quickly adds the article to the your vault. 
+This is a great tool for researchers, students, and anyone who wants to save and organize articles for later reading and reference.
+
+## Screenshots
+![gif showing the whole workflow from a website to saved article](./images/Demo.gif)
+![screenshot displaying various options for configuration](./images/Options.png)
+![screenshot of the saved article in Obsidian](./images/Result.png)
 
 ## Install
 
@@ -15,7 +20,30 @@
 
 Suggestions and pull requests are welcomed!.
 
+### Available Scripts
+- npm run watch
+    - Listens for files changes and rebuilds automatically.
+- npm run build
+    - Bundles the app into static files for Chrome store.
+- npm run format
+    - Formats all the files.
+- npm run test
+    - Runs unit tests
+
+### Workflow
+1. cd obsidian-clipper
+2. Run npm run watch
+3. Open chrome://extensions
+4. Check the Developer mode checkbox
+5. Click on the Load unpacked extension button
+6. Select the folder obsidian-clipper/build
+
 ---
 
 This project was bootstrapped with [Chrome Extension CLI](https://github.com/dutiyesh/chrome-extension-cli)
 
+### Attribution
+
+This is adopted and adjusted by https://gist.github.com/kepano/90c05f162c37cf730abb8ff027987ca3 and packaged as a Chrome extensions for convenience.
+
+<a target="_blank" href="https://icons8.com/icon/0eNM6EFToRF2/obsidian">Obsidian</a> icon by <a target="_blank" href="https://icons8.com">Icons8</a>
diff --git a/TUTORIAL.txt b/TUTORIAL.txt
diff --git a/images/Demo.gif b/images/Demo.gif
diff --git a/images/Options.png b/images/Options.png
diff --git a/images/Result.png b/images/Result.png
diff --git a/src/options.ts b/src/options.ts
@@ -10,15 +10,20 @@ export const STORAGE_KEYS = {
 
 export type Keys = typeof STORAGE_KEYS[keyof typeof STORAGE_KEYS]
 
+function sanitizeInput(input: string) {
+  return input.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/"/g, '&quot;');
+}
+
 function save_options() {
   const vault = (document.getElementById('vault') as HTMLInputElement).value;
   const folder = (document.getElementById('folder') as HTMLInputElement).value;
   const tag = (document.getElementById('tag') as HTMLInputElement).value;
+
   chrome.storage.sync.set(
     {
-      [STORAGE_KEYS.VAULT_NAME]: vault,
-      [STORAGE_KEYS.FOLDER]: folder,
-      [STORAGE_KEYS.TAG]: tag,
+      [STORAGE_KEYS.VAULT_NAME]: sanitizeInput(vault),
+      [STORAGE_KEYS.FOLDER]: sanitizeInput(folder),
+      [STORAGE_KEYS.TAG]: sanitizeInput(tag),
     },
     () => {
       // Update status to let user know options were saved.

diff --git a/tests/yaml.test.ts → src/yaml.test.ts b/tests/yaml.test.ts → src/yaml.test.ts
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "rootDir": "src",
     "target": "es6",
     "module": "commonjs",
     "esModuleInterop": true,