Home

Awesome

<div align="center"> <img alt="Grimoire Logo" src="assets/icon.png"> <h1>grimoire companion</h1> <p>Web extension for Grimoire - a bookmark manager for the wizards 🧙</p> <img alt="GitHub License" src="https://img.shields.io/github/license/goniszewski/grimoire-web-extension"> <img alt="GitHub Release" src="https://img.shields.io/github/v/release/goniszewski/grimoire-web-extension"> </div> <br>

Adding bookmarks to Grimoire is now easier than ever! With the Grimoire Companion, you can add bookmarks to your Grimoire account directly from your browser. Just click the extension icon, select the category and tags, and press "Add Bookmark" - it's that simple!

Features

<div align="center"> <img alt="Grimoire Companion Screenshot" src="assets/screenshot_1280_800.png"> </div>

Where to get it?

At the moment, grimoire companion is available for download on the following platforms:

<div align="center"> <a href="https://addons.mozilla.org/en-GB/firefox/addon/grimoire-companion/"> <img alt="Firefox Add-ons" src="assets/firefox-addons-button.webp"> </a> <a href="https://chromewebstore.google.com/detail/grimoire-companion/mbciogjbnegofhhhlcbmlobjcgjdbgfh"> <img alt="Chrome Web Store" src="assets/chrome-web-store-button.png"> </a> </div>

Development

Prerequisites

Steps

# Clone the repository
git clone https://github.com/goniszewski/grimoire-web-extension

# Install the dependencies
pnpm i

# Run the development version
pnpm dev

# Build the production version (by default, this will create the Chrome extension for local development in `build/chrome-mv3-prod`)
pnpm build

How to load the extension in Chrome-based browsers

Development

Check out the the official Plasmo documentation to learn more.

Roadmap

We're open to suggestions and feature requests! If you have an idea for a feature, please open an issue.

Contributing

If you want to contribute to the project, please read the contributing guide.

License

This project is licensed under the MIT License.

Credits

Special thanks to: DaisyUI, Plasmo, Svelte, Svelte French Toast, Svelte MultiSelect, Tailwind CSS