From e5657e4ffdfd88c4c622ad8c649c3ce786d63245 Mon Sep 17 00:00:00 2001 From: Allen Gilliland Date: Mon, 3 Apr 2017 10:44:58 -0700 Subject: [PATCH] add a little info about how to install from npm --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 8236e0b..5476fd1 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,21 @@ An implementation of ISO 13790-2008 and limited to only single-zone building def # Installation (npm) +``` +npm install --save buildzero-energy-model +``` + # Usage +``` +var EnergyModel = require('buildzero-energy-model'); + +// check out the example.js file to see what the input data structures are meant to look like. +// better docs coming once things are more finalized. +var modelResults = EnergyModel.thermalDemand(buildingSettings, hourlyConditions, buildingElements, climateData); +``` + + # License Unless otherwise specified all BuildZero.org source files are made available under the terms of the MIT License (MIT). See [LICENSE.txt](https://github.com/buildzero/energy-model/blob/master/LICENSE.txt) for details.