Skip to content

Commit

Permalink
Merge pull request origo-map#1637 from origo-map/plugins_doc
Browse files Browse the repository at this point in the history
docs: Plugins doc
  • Loading branch information
filleg authored Jan 4, 2023
2 parents 2dfb316 + 60ea965 commit 69bfdd8
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions PLUGINS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@

# Origo plugins
More information about how to develop and utilize plugins with Origo will be added soon.
Plugins are to be developed when a feature or function is not appropriate to be included in the origo core. Common reasons are external dependencies or a specific feature or function not requested by the average user.
## Guidelines development

**[Barebone](https://github.com/origo-map/barebone-plugin)** is an example plugin to provide an initial structure of how you can start developing your plugin.

Origo core has a lot of dependencies by default which are available to use from the plugins. They should be utilized first before loading more external libraries.

Smaller adjustment to the core might be necessary but should be avoided to make the plugin as standalone as possible.

## Available plugins
Below is a list of available plugins. More information about each plugin can be found in the plugin's own repository.
Expand Down

0 comments on commit 69bfdd8

Please sign in to comment.