forked from NebulousLabs/Sia-UI
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Broke general Plugins.md out of PluginTutorial.md
- Loading branch information
1 parent
1d98ff8
commit d98419e
Showing
5 changed files
with
33 additions
and
47 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
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,3 +1,4 @@ | ||
# Development Flow | ||
|
||
## Packaging & Releasing Sia-UI | ||
|
||
|
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
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,30 @@ | ||
# Plugins | ||
|
||
In order to form a more modular codebase, most functionality in the UI is | ||
contained in webpage like structures we call "Plugins". | ||
|
||
## What is a plugin? | ||
|
||
A plugin, in the context of Sia-UI, is a self-contained add-on that offers | ||
graphical functionality to interact with the Sia-network. We'll develop plugins | ||
we believe would be widely used, but we're also redesigning Sia-UI to enable | ||
third-party developers interested in our project to make their own plugins. | ||
|
||
The structure of a plugin is the exact same as a webpage, with some added | ||
functionality via Node.js & Electron. There are only two hard-rules to a | ||
plugin: | ||
|
||
1. It must be self-contained in a directory of its name. | ||
2. It must have an index.html in this directory. | ||
|
||
## Why plugins? | ||
|
||
We at NebulousLabs are all about decentralization... of everything! Thus we are | ||
redesigning our GUI desktop application with that in mind. We want the | ||
community interested in the Sia network to be able to: | ||
|
||
1. Use Sia-UI in the way they want with only the plugins they care about instead | ||
of using our rigid set of tools. | ||
2. Be able to design and implement their own plugins. | ||
3. Customize their own UI experience simply without obfuscating menubars. | ||
|
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