diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 28 |
1 files changed, 21 insertions, 7 deletions
@@ -1,4 +1,4 @@ -coinfetch +Coinfetch ========= See [INSTALL](INSTALL) for installation instructions. @@ -36,15 +36,29 @@ 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. +Installing Plugins +------------------ + +Plugins are read from a number of directories. 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. +- The `.coinfetch/plugins` directory in the user's home directory. + +Any file ending in `.py` will be loaded using Python standard `import` +logic. No functions will be executed by `coinfetch` directly. You must execute +them at the global level if needed. See the default plugins in `cfetch/plugins` +for examples of simple working plugins. + Note ---- -Version 5.x is currently in development. This will change the program from a -static API/CLI to a plugin-based system with an API for external applications -as well as the familiar CLI. The advantage of this new design is to allow -hackers to add new APIs to Coinfetch without having to submit upstream -requests. Officially-supported ticker APIs will stay in this repository to keep -things easy for existing Coinfetch users. +Version 5.x changes the program from a static API/CLI to a plugin-based system +with an API for external applications as well as the familiar CLI. The +advantage of this new design is to allow hackers to add new APIs to Coinfetch +without having to submit upstream requests. Officially-supported ticker APIs +will stay in this repository to keep things easy for existing Coinfetch users. BTer's ticker (as of this update) does not seem to be updating often enough to have accurate data. Version 4.1.x adds the CryptoCoin Charts (ccc) API which |