summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid McMackins II <contact@mcmackins.org>2015-08-29 11:57:51 -0500
committerDavid McMackins II <contact@mcmackins.org>2015-08-29 11:57:51 -0500
commitbe8e716b798bb06ac94af0eb2c7f1cddffe38c50 (patch)
treee679dc66fdaf05d7a1e92687ab5b8ec3221b8a28
parent204e59b209b6f9663ab6a7e1b0b49fef6cf2b121 (diff)
Added information about how plugins are loaded
-rw-r--r--README9
1 files changed, 8 insertions, 1 deletions
diff --git a/README b/README
index b4bc124..59a0e1b 100644
--- a/README
+++ b/README
@@ -36,14 +36,21 @@ Example: `$ coinfetch -a bter usd doge`
The above example will be the same as calling `coinfetch usd doge` in version
2.x, which used the BTer API. The default API is BTC-E.
+For help using `coinfetch` and for a list of options, use `coinfetch --help`.
+
Installing Plugins
------------------
-Plugins are read from a number of directories. Currently, these are:
+Plugins are read from a number of directories in a particular
+order. Directories lower on this list with override those higher on the list,
+since duplicate entries will be registered over one another in the load
+order. Currently, these are:
- `cfetch/plugins` located in this source repository and installed to the
system after installation.
- `/usr/share/coinfetch/plugins` on Unix-like operating systems.
+- `/usr/local/share/coinfetch/plugins` for user-installed plugins on Unix-like
+operating systems.
- The `.coinfetch/plugins` directory in the user's home directory.
Any file ending in `.py` will be loaded using Python standard `import`