##Welcome to the CFPM! We want CFPM to be the easiest experience you have had with ColdFusion, so here is a quick demonstration of how to use CFPM.
If you have any problems or questions, please email me at william.h.giles@gmail.com
###Installing CFPM Installation of CFPM requires that you have git and node / npm installed. If you haven't installed either, please do so now. ----- ####Downloading CFPM Next we will need to install the cfpm node library npm i cfpm-io -g ----- ####Initialize your Project Once you have installed CFPM, change directories to your project and initialize cfpm by calling cfpm init This will guide you though a few questions to get you up and running ----- ####Installing Packages If you already have a cfpm.json file and packages in your file, you can easily install all the packages with the call cfpm ----- ####Adding a Package If you want to add a package, you can easily do so by calling cfpm add ----- ####Include CFPM into your application The true magic of CFPM is the ability to require packages throughout your application, when and where you need them. This ensures we don't load everything all the time and keeps complexity down. To require CFPM in your applicatin, add the following code to your application.cfc. application.cfpm = new cfpm(); ----- ####Your done! Congrats! You now have cfpmed and ready to go. You can access the packages anywhere in your application by calling application.cfpm.require('package_name'); Still not sure about everything? Scroll down for a small example of CFPM being used ----- #Example Code ----- cfpm add utils ----- application.cfc component { application.cfpm = new cfpm(); } ----- index.cfm
<cfscript>
    utils = application.cfpm.require('utils');
    test = 'hello world';
    test = utils.upperCaseWords(test);
    writeOutput(test); // "Hello World"
</cfscript>