Skip to content

Commit

Permalink
Add notes on how to install plugins
Browse files Browse the repository at this point in the history
Signed-off-by: Axel Boberg <[email protected]>
  • Loading branch information
axelboberg committed May 16, 2024
1 parent d3eb044 commit 80c1c56
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Welcome to the full documentation for Bridge. Whether you want to build your own
- [Guide](/docs/plugins/README.md)
- [Examples](/examples)
- [API reference](/docs/api/README.md)
- [Installing plugins](/docs/plugins/installation.md)

## Internals
- [Architecture](/docs/architecture.md)
Expand Down
1 change: 1 addition & 0 deletions docs/plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Plugins allows Bridge to be extended with functionality, both through the backen
- [main](#main)
- [engines](#engines)
- [contributes](#contributes)
- [Installing plugins](./installation.md)
- [API reference](/docs/api/README.md)

## Examples
Expand Down
16 changes: 16 additions & 0 deletions docs/plugins/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Installing plugins

Installing plugins to Bridge is as simple as placing the plugin source in the plugins directory on your computer.

## 1. Find the plugin directory
The easiest way of finding the plugin directory is opening Bridge and going to "Manage Plugins..." in the application menu. This will open the correct path in Finder / Explorer.

![Manage Plugins](/media/docs/plugins/manage-plugins.png)

## 2. Copy the plugin source
Place the plugin's source directory into Bridge's plugins directory. This is a simple matter of copy/paste.

![Plugins directory](/media/docs/plugins/directory.png)

## 3. Restart Bridge
Restart Bridge to enjoy your newly installed plugin.
Binary file added media/docs/plugins/directory.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/docs/plugins/manage-plugins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 80c1c56

Please sign in to comment.