From 0e9282e0796e1918f21fbdfc1a5bb00f273d8db0 Mon Sep 17 00:00:00 2001 From: Eugene Pankov Date: Sat, 1 Jul 2017 14:13:07 +0200 Subject: [PATCH] docs --- HACKING.md | 4 ++++ README.md | 9 +++++++++ 2 files changed, 13 insertions(+) diff --git a/HACKING.md b/HACKING.md index 7af3b0d3..cdfce578 100644 --- a/HACKING.md +++ b/HACKING.md @@ -69,6 +69,10 @@ terminus-pluginname The app will load all plugins from the source checkout in the dev mode, from the user's plugins directory at all times (click `Open Plugins Directory` under `Settings` > `Plugins`) and from the directory specified by the `TERMINUS_PLUGINS` environment var. +Only modules whose `package.json` file contains a `terminus-plugin` keyword will be loaded. + +If you're currently in your plugin's directory, start Terminus as `TERMINUS_PLUGINS=$(pwd) terminus --debug` + A plugin should only provide a default export, which should be a `NgModule` class (or a `NgModuleWithDependencies` where applicable). This module will be injected as a dependency to the app's root module. ```javascript diff --git a/README.md b/README.md index 77d553b5..8a05af8e 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,15 @@ --- +# Plugins + +Plugins can be installed directly from the Settings view inside Terminus. + + * [clickable-links](https://github.com/Eugeny/terminus-clickable-links) - makes paths and URLs in the terminal clickable + * [theme-hype](https://github.com/Eugeny/terminus-theme-hype) - a Hyper inspired theme + +--- + # Contributing Pull requests and plugins are welcome! Publish your plugin on NPM with a `terminus-plugin` keyword to make them appear in the Plugin Manager.