docs: 💬 update plugin branding to quickshare

This commit is contained in:
Maxime Cannoodt
2022-08-16 20:48:29 +02:00
parent 30b2d26847
commit 7ea11903f8
7 changed files with 19 additions and 20 deletions

View File

@@ -21,7 +21,7 @@ Each subproject (plugin, server, and webapp) is its own npm package with its own
| (root) | (root)
|-- package.json |-- package.json
|-- docker-compose.yml |-- docker-compose.yml
|-- plugin/ // (Obsidian plugin, as submodule at mcndt/obsidian-note-sharing) |-- plugin/ // (Obsidian plugin, as submodule at mcndt/obsidian-quickshare)
|-- package.json |-- package.json
|-- Dockerfile |-- Dockerfile
|-- server/ // (Express + Prisma + SQLite) |-- server/ // (Express + Prisma + SQLite)
@@ -44,7 +44,7 @@ npm run dev
Running the script starts a dev server for each, recompiling code on file changes. A reverse proxy (`proxy.js` in project root) runs the entire application at `http://localhost:5000`. Running the script starts a dev server for each, recompiling code on file changes. A reverse proxy (`proxy.js` in project root) runs the entire application at `http://localhost:5000`.
If you want to contribute solely to the Obsidian plugin, please pull from the [obsidian-note-sharing](https://github.com/mcndt/obsidian-note-sharing) repo directly. If you want to contribute solely to the Obsidian plugin, please pull from the [obsidian-quickshare](https://github.com/mcndt/obsidian-quickshare) repo directly.
Before you can store notes in the local development environment, you must migrate the local SQLite database (see next section). Before you can store notes in the local development environment, you must migrate the local SQLite database (see next section).

2
plugin

Submodule plugin updated: 699b2b93a6...46e53a6d66

View File

@@ -1,5 +1,5 @@
{ {
"name": "obsidian-note-sharing-server", "name": "obsidian-quickshare-server",
"version": "0.0.1", "version": "0.0.1",
"description": "Express + SQLite3 + Prisma app for hosting encrypted notes.", "description": "Express + SQLite3 + Prisma app for hosting encrypted notes.",
"main": "server.js", "main": "server.js",

View File

@@ -1,5 +1,5 @@
{ {
"name": "obsidian-note-sharing-webapp", "name": "obsidian-quickshare-webapp",
"version": "0.0.1", "version": "0.0.1",
"description": "SvelteKit webapp for fetching, decrypting and rendering obsidian notes.", "description": "SvelteKit webapp for fetching, decrypting and rendering obsidian notes.",
"author": "Maxime Cannoodt (mcndt)", "author": "Maxime Cannoodt (mcndt)",

View File

@@ -11,14 +11,14 @@
Hi! I'm Hi! I'm
<a href="https://mcndt.dev">mcndt</a> <a href="https://mcndt.dev">mcndt</a>
and I build the Obsidian note sharing plugin and operate Noteshare.space. There are several ways to and I build the Obsidian QuickShare plugin and operate Noteshare.space. There are several ways to get
get in touch with me. in touch with me.
<h2>Bugs and feature requests</h2> <h2>Bugs and feature requests</h2>
<p> <p>
The preferred way to report bugs or request new features for the web app or the Obsidian plugin The preferred way to report bugs or request new features for the web app or the Obsidian plugin
is via the is via the
<a class="underline" href="https://github.com/mcndt/obsidian-note-sharing/issues" <a class="underline" href="https://github.com/mcndt/obsidian-quickshare/issues"
>GitHub issues page</a >GitHub issues page</a
>. >.
</p> </p>
@@ -30,7 +30,7 @@
<h2>Questions about Noteshare.space</h2> <h2>Questions about Noteshare.space</h2>
<p> <p>
For questions and inquiries about Noteshare.space (the "official" note hosting service for the For questions and inquiries about Noteshare.space (the "official" note hosting service for the
Obsidian note sharing plugin), please E-mail me at <a href="mailto:contact@noteshare.space" Obsidian QuickShare plugin), please E-mail me at <a href="mailto:contact@noteshare.space"
>contact@noteshare.space</a >contact@noteshare.space</a
>. >.
</p> </p>

View File

@@ -73,8 +73,7 @@
<p slot="text"> <p slot="text">
Want to verify the security of the encryption mechanism? Or host your own instance? Want to verify the security of the encryption mechanism? Or host your own instance?
Noteshare.space is completely <strong class="whitespace-nowrap" Noteshare.space is completely <strong class="whitespace-nowrap"
><a class="underline" href="https://github.com/mcndt/obsidian-note-sharing" ><a class="underline" href="https://github.com/mcndt/Noteshare.space">open-source</a
>open-source</a
></strong ></strong
> under the MIT license. > under the MIT license.
</p> </p>

View File

@@ -17,8 +17,8 @@
<p> <p>
To beta test, you can install the plugin using BRAT and the GitHub URL (<a To beta test, you can install the plugin using BRAT and the GitHub URL (<a
href="https://github.com/mcndt/obsidian-note-sharing" href="https://github.com/mcndt/obsidian-quickshare"
>https://github.com/mcndt/obsidian-note-sharing</a >https://github.com/mcndt/obsidian-quickshare</a
>) (see >) (see
<a <a
href="https://github.com/TfTHacker/obsidian42-brat#adding-a-beta-plugin) for further href="https://github.com/TfTHacker/obsidian42-brat#adding-a-beta-plugin) for further
@@ -27,23 +27,23 @@
</p> </p>
<p> <p>
Please report any problems you encounter in the plugin Please report any problems you encounter in the plugin
<a href="https://github.com/mcndt/obsidian-note-sharing/issues">bug tracker</a>. <a href="https://github.com/mcndt/obsidian-quickshare/issues">bug tracker</a>.
</p> </p>
</div> </div>
<a href="https://github.com/mcndt/obsidian-note-sharing" <a href="https://github.com/mcndt/obsidian-quickshare"
><img src="https://gh-card.dev/repos/mcndt/obsidian-note-sharing.svg" alt="github-repo-card" /></a ><img src="https://gh-card.dev/repos/mcndt/obsidian-quickshare.svg" alt="github-repo-card" /></a
> >
<div class="flex gap-2 mt-2"> <div class="flex gap-2 mt-2">
<a href="https://github.com/mcndt/obsidian-note-sharing/releases"> <a href="https://github.com/mcndt/obsidian-quickshare/releases">
<img <img
src="https://img.shields.io/github/v/tag/mcndt/obsidian-note-sharing" src="https://img.shields.io/github/v/tag/mcndt/obsidian-quickshare"
alt="github-version-tag" alt="github-version-tag"
/> />
</a> </a>
<a href="https://github.com/mcndt/obsidian-note-sharing"> <a href="https://github.com/mcndt/obsidian-quickshare">
<img <img
src="https://img.shields.io/github/downloads/mcndt/obsidian-note-sharing/total" src="https://img.shields.io/github/downloads/mcndt/obsidian-quickshare/total"
alt="github-downloads-tag" alt="github-downloads-tag"
/> />
</a> </a>