-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from relay-md/release/20240209
Release/20240209
- Loading branch information
Showing
3 changed files
with
355 additions
and
108 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # 🐝 Developer Section | ||
|
|
||
| What comes below is meant for developers and maintainers. | ||
|
|
||
| ## 🚢 Releasing new releases | ||
|
|
||
| Releases are entirely managed in github actions and only require a pull-request | ||
| against `master` to be merged. Semantic versioning in connection with | ||
| conventional commits will take care of versioning | ||
|
|
||
| ## 🏠 How to build | ||
|
|
||
| - Clone this repo. | ||
| - Make sure your NodeJS is at least v16 (`node --version`). | ||
| - `npm i` or `yarn` to install dependencies. | ||
| - `npm run dev` to start compilation in watch mode. | ||
| - (optionally) `npm run lint` to check coding style | ||
|
|
||
| ## 🎯 Manually installing the plugin | ||
|
|
||
| Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/relay-md/`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,72 @@ | ||
| <p align="center"> | ||
| <img src="https://relay.md/static/img/logo-navbar.svg" height="150" /> | ||
| </p> | ||
| <p align="center"> | ||
| <img alt="GitHub Release" src="https://img.shields.io/github/v/release/relay-md/relay-md-obsidian-plugin"> | ||
| <img src="https://img.shields.io/github/actions/workflow/status/relay-md/relay-md-obsidian-plugin/release.yml" alt="GitHub Actions Workflow Status"> | ||
| <img src="https://img.shields.io/github/downloads/relay-md/relay-md-obsidian-plugin/total" alt="GitHub Downloads (all assets, all releases)"> | ||
| <img src="https://img.shields.io/github/contributors/relay-md/relay-md-obsidian-plugin" alt="GitHub contributors"> | ||
| <img src="https://img.shields.io/github/last-commit/relay-md/relay-md-obsidian-plugin" alt="GitHub last commit"> | ||
| <img src="https://img.shields.io/github/languages/count/relay-md/relay-md-obsidian-plugin" alt="GitHub language count"> | ||
| <img src="https://img.shields.io/github/license/relay-md/relay-md-obsidian-plugin" alt="GitHub License"> | ||
| <img src="https://img.shields.io/mozilla-observatory/grade/relay.md" alt="Mozilla HTTP Observatory Grade"> | ||
| <img src="https://img.shields.io/github/watchers/relay-md/relay-md-obsidian-plugin" alt="GitHub watchers"> | ||
| <img src="https://img.shields.io/github/stars/relay-md/relay-md-obsidian-plugin" alt="GitHub Repo stars"> | ||
| </p> | ||
| <p align="center"> | ||
| <a href="https://www.buymeacoffee.com/fabian.schuh"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt=""Buy Me A Coffee""></a> | ||
| </p> | ||
|
|
||
| # Relay.md Obsidian plugin | ||
|
|
||
| This repo contains an [Obsidian](https://obsidian.md) plugin for [relay.md](https://relay.md). | ||
|
|
||
| The purpose of relay.md is to make sharing markdown files fun again. In | ||
| particular, we want to establish "Markdown workflows for teams". | ||
| 🎉 The purpose of relay.md is to make **sharing markdown files fun again**. | ||
|
|
||
| Relay.md makes it easy to send documents to groups or people or individuals and | ||
| allows to subscribe to entire teams and their documents. This will allow | ||
| individual team members to share their knowledge with the entire team from | ||
| within Obsidian. No more copy&pasting and editing into some strange wiki-syntax. | ||
| Relay.md enables **quick** and **easy** sharing of documents with a team and | ||
| allows to **subscribe** to individual subjects. Individual team members to share | ||
| their knowledge with the entire team from | ||
| within Obsidian. | ||
|
|
||
| * ❌ No more **copy&pasting** to share a document with your team. | ||
| * ❌ No more changing syntax because your mail client does not support Markdown | ||
| * ❌ No more moving your hands away from keyboard to your mouse | ||
| * ❌ No more looking up email addresses | ||
| * ✅ share your document with the right people in seconds | ||
|
|
||
| Further, those that deal with different projects, teams or clients, can keep | ||
| their information aggregated within Obsidian and send out their documents to | ||
| corresponding people from within Obsidian. Got your specs for | ||
| *new-start-up-feature-A* ready, send them out to the tech team of the startup. | ||
| Finished writing a consultancy contract for *business B*, have them notified | ||
| from within Obsidian by sendind the docs via relay.md. | ||
| Further, those that deal with different projects, teams or clients, can keep | ||
| their information aggregated within **as single vault** and send out their documents to | ||
| corresponding people from within Obsidian. | ||
|
|
||
| 🤩 Send specification to the right people in your team using **topics**. | ||
| from within Obsidian by sending the docs via relay.md. | ||
|
|
||
| 🎯 Most importantly, you get to keep your knowledge together! | ||
|
|
||
| # 🏠 Installation | ||
|
|
||
| 1. [open relay.md plugin in Obsidian](obsidian://show-plugin?id=relay-md) | ||
| 2. click **install** | ||
| 3. click **enable** | ||
| 4. click **configure** | ||
|
|
||
| Most importantly, you get to keep your stuff together! | ||
| # 🪢 Link your account with relay.md | ||
| 1. Open plugin configuration | ||
| 2. Click **obtain access to relay.md** | ||
| 3. 🎉 Ready to rumble | ||
|
|
||
| # Howto: | ||
| # 📶 Use the Plugin | ||
|
|
||
| Using relay.md couldn't be easier with Obsidian. All you need to do is specify | ||
| the recipient(s) in the frontmatter using: | ||
| the recipient(s) in the **frontmatter** using: | ||
|
|
||
| ``` | ||
| relay-to: | ||
| - label@team | ||
| - subject@team-name | ||
| - @funnyfriend49 | ||
| ``` | ||
|
|
||
| Upon updating the document, the file will be sent to relay.md using your | ||
| personal access token. As soon as your friends open up their Obsidian, the | ||
| relay.md plugin will automatically retrieve all documents that have been created | ||
| or updated. | ||
|
|
||
| # Developer Section | ||
|
|
||
| What comes below is meant for developers and maintainers. | ||
|
|
||
| ## Releasing new releases | ||
| Releases are entirely managed in github actions and only require a pull-request | ||
| against `master` to be merged. Semantic versioning in connection with | ||
| conventional commits will take care of versioning | ||
|
|
||
| ## How to build | ||
|
|
||
| - Clone this repo. | ||
| - Make sure your NodeJS is at least v16 (`node --version`). | ||
| - `npm i` or `yarn` to install dependencies. | ||
| - `npm run dev` to start compilation in watch mode. | ||
| - (optionally) `npm run lint` to check coding style | ||
|
|
||
| ## Manually installing the plugin | ||
|
|
||
| Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/relay-md/`. | ||
| 1. Upon updating the document, the file will be sent to relay.md | ||
| 2. Your access credentials are stored in your vault during configuration | ||
| 3. As soon as your team mates open up their Obsidian, the relay.md plugin will automatically retrieve all documents that have been created or updated for them. |
Oops, something went wrong.