Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #68

Merged
merged 2 commits into from
Jan 25, 2024
Merged

Update README #68

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
274e19c
README: reformat
henrytill Jan 25, 2024
ea995e1
README: update firefox-related info
henrytill Jan 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Noematic is an experimental browser extension that reimagines bookmarking. When

Noematic is currently comprised of two components:

- a web extension, usable in Firefox or Chromium browsers
- a native executable which communicates with the extension using [native messaging](https://developer.chrome.com/docs/extensions/mv3/nativeMessaging/).
- a web extension, currently usable in Chromium-family browsers. Firefox support is planned (see #1).
- a native executable which communicates with the extension using [native messaging](https://developer.chrome.com/docs/extensions/mv3/nativeMessaging/).

### Build

Expand All @@ -35,24 +35,23 @@ make
The extension build products can be loaded from:

```
extension/dist/firefox
extension/dist/chromium
```

### Native Manifest File

Refer to the native messaging documentation for [Firefox](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_manifests) or [Chromium](https://developer.chrome.com/docs/extensions/mv3/nativeMessaging/) for more information, including manifest file locations for various platforms.
Refer to the native messaging documentation for [Chromium](https://developer.chrome.com/docs/extensions/mv3/nativeMessaging/) for more information, including manifest file locations for various platforms.

On Linux, native manifests for both browsers can installed using the following command:
On Linux, a native manifest can be installed using the following command:

```sh
make create_host_manifest
```

The native manifests point directly to the debug executable.
The native manifest points directly to the debug executable.

### Useful Documentation

- <https://developer.chrome.com/docs/extensions/reference/runtime/>
- <https://developer.chrome.com/docs/extensions/mv3/messaging/>
- <https://developer.chrome.com/docs/extensions/mv3/nativeMessaging/>
- <https://developer.chrome.com/docs/extensions/reference/runtime/>
- <https://developer.chrome.com/docs/extensions/mv3/messaging/>
- <https://developer.chrome.com/docs/extensions/mv3/nativeMessaging/>
Loading