@mejazbese21/obsidian-clipper-cli 1.6.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Obsidian
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,109 @@
+Obsidian Web Clipper helps you highlight and capture the web in your favorite browser. Anything you save is stored as durable Markdown files that you can read offline, and preserve for the long term.
+
+- **[Download Web Clipper](https://obsidian.md/clipper)**
+- **[Documentation](https://help.obsidian.md/web-clipper)**
+- **[Troubleshooting](https://help.obsidian.md/web-clipper/troubleshoot)**
+
+## Get started
+
+Install the extension by downloading it from the official directory for your browser:
+
+- **[Chrome Web Store](https://chromewebstore.google.com/detail/obsidian-web-clipper/cnjifjpddelmedmihgijeibhnjfabmlf)** for Chrome, Brave, Arc, Orion, and other Chromium-based browsers.
+- **[Firefox Add-Ons](https://addons.mozilla.org/en-US/firefox/addon/web-clipper-obsidian/)** for Firefox and Firefox Mobile.
+- **[Safari Extensions](https://apps.apple.com/us/app/obsidian-web-clipper/id6720708363)** for macOS, iOS, and iPadOS.
+- **[Edge Add-Ons](https://microsoftedge.microsoft.com/addons/detail/obsidian-web-clipper/eigdjhmgnaaeaonimdklocfekkaanfme)** for Microsoft Edge.
+
+## Use the extension
+
+Documentation is available on the [Obsidian Help site](https://help.obsidian.md/web-clipper), which covers how to use [highlighting](https://help.obsidian.md/web-clipper/highlight), [templates](https://help.obsidian.md/web-clipper/templates), [variables](https://help.obsidian.md/web-clipper/variables), [filters](https://help.obsidian.md/web-clipper/filters), and more.
+
+## Contribute
+
+### Translations
+
+You can help translate Web Clipper into your language. Submit your translation via pull request using the format found in the [/_locales](/src/_locales) folder.
+
+### Features and bug fixes
+
+See the [help wanted](https://github.com/obsidianmd/obsidian-clipper/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) tag for issues where contributions are welcome.
+
+## Roadmap
+
+In no particular order:
+
+- [ ] Annotate highlights
+- [ ] Template directory
+- [ ] Sync settings across browsers
+- [x] A separate icon for Web Clipper (1.6.3)
+- [x] Template validation (1.1.0)
+- [x] Template logic (if/for)  (1.1.0)
+- [x] Save images locally ([Obsidian 1.8.0](https://obsidian.md/changelog/2024-12-18-desktop-v1.8.0/))
+- [x] Translate UI into more languages — help is welcomed
+
+## Developers
+
+To build the extension:
+
+```
+npm run build
+```
+
+This will create three directories:
+- `dist/` for the Chromium version
+- `dist_firefox/` for the Firefox version
+- `dist_safari/` for the Safari version
+
+### Install the extension locally
+
+For Chromium browsers, such as Chrome, Brave, Edge, and Arc:
+
+1. Open your browser and navigate to `chrome://extensions`
+2. Enable **Developer mode**
+3. Click **Load unpacked** and select the `dist` directory
+
+For Firefox:
+
+1. Open Firefox and navigate to `about:debugging#/runtime/this-firefox`
+2. Click **Load Temporary Add-on**
+3. Navigate to the `dist_firefox` directory and select the `manifest.json` file
+
+If you want to run the extension permanently you can do so with the Nightly or Developer versions of Firefox.
+
+1. Type `about:config` in the URL bar
+2. In the Search box type `xpinstall.signatures.required`
+3. Double-click the preference, or right-click and select "Toggle", to set it to `false`.
+4. Go to `about:addons` > gear icon > **Install Add-on From File…**
+
+For iOS Simulator testing on macOS:
+
+1. Run `npm run build` to build the extension
+2. Open `xcode/Obsidian Web Clipper/Obsidian Web Clipper.xcodeproj` in Xcode
+3. Select the **Obsidian Web Clipper (iOS)** scheme from the scheme selector
+4. Choose an iOS Simulator device and click **Run** to build and launch the app
+5. Once the app is running on the simulator, open **Safari**
+6. Navigate to a webpage and tap the **Extensions** button in Safari to access the Web Clipper extension
+
+### Run tests
+
+```
+npm test
+```
+
+Or run in watch mode during development:
+
+```
+npm run test:watch
+```
+
+## Third-party libraries
+
+- [webextension-polyfill](https://github.com/mozilla/webextension-polyfill) for browser compatibility
+- [defuddle](https://github.com/kepano/defuddle) for content extraction and Markdown conversion
+- [dayjs](https://github.com/iamkun/dayjs) for date parsing and formatting
+- [lz-string](https://github.com/pieroxy/lz-string) to compress templates to reduce storage space
+- [lucide](https://github.com/lucide-icons/lucide) for icons
+- [dompurify](https://github.com/cure53/DOMPurify) for sanitizing HTML
+
+## License
+
+Obsidian Web Clipper source code is open source under the MIT License. All trademarks, icons, marketing copy, and other marketing assets are excluded from that license.