diff --git a/README.md b/README.md new file mode 100644 index 0000000..5b685ca --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Ternary Plot Mod for TIBCO Spotfire® + +A barycentric plot on three variables which sum to a constant to graphically depicts the ratios of the three variables as positions in an equilateral triangle. + +It is often used in physical chemistry, petrology, mineralogy, metallurgy, and other physical sciences to show the compositions of systems composed of three species. + +## Installation & Use + +The [Wiki](https://github.com/TIBCOSoftware/spotfire-mod-ternary/wiki) contains step-by-step instruction on how to install and use this Mod in TIBCO Spotfire®. + +## Building the Project + +In a terminal window: +- `npm install` +- `npm start` + +In a new terminal window: +- `npm run server` + +## About Mods for TIBCO Spotfire® +- [TIBCO Community Exchange](https://community.tibco.com/s/global-search/%40uri#q=mod%20for%20tibco%20spotfire&t=Exchange&sort=date%20descending): A safe and trusted place to discover ready-to-use mods +- [Developer documentation](https://tibcosoftware.github.io/spotfire-mods/docs/): Introduction and tutorials for mods developers +- [Mods examples made by TIBCO](https://github.com/TIBCOSoftware/spotfire-mods/releases/latest): A public repository for examples projects