Skip to content

Commit

Permalink
Quick refresh of the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
joshbtn committed Feb 13, 2017
1 parent 2eb403f commit 6a8f5b2
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
18 changes: 11 additions & 7 deletions README.md
Expand Up @@ -2,10 +2,12 @@

[![Build Status](https://travis-ci.org/joshbtn/excelFormulaUtilitiesJS.svg?branch=master)](https://travis-ci.org/joshbtn/excelFormulaUtilitiesJS)

## ExcelFormulaBeautifier.com
To submit pull requests for ExcelFormulaBeautifier.com please oppen a pull request after gh-pages branch.
To submit pull requests for [ExcelFormulaBeautifier.com](http://ExcelFormulaBeautifier.com) please use this branch.
Changes to the core js library live in the master branch.
Excel Formula Utilities for JavaScript is a library that can be used to
pretty print excel formulas or convert excel formulas into JavaScript.
The JavaScript generated by this library will not execute on it's own.
You'll need to include something like
[formula.js](https://github.com/sutoiku/formula.js/) to cover all the functions
from Excel.

##Install using npm
npm install excel-formula
Expand All @@ -14,17 +16,19 @@ npm install excel-formula
Grab the latest js files in the dist folder.

## Basic usage for web
```html
<script src="excel-formula.js" />
<script>
var formattedFormula = excelFormulaUtilities.formatFormulaHTML('IF(1+1=2,"true","false")');
alert(formattedFormula)
</script>

```
## Basic Usage for Node
```javascript
var formula = require('excel-formula');
var formattedFormula = formula.formatFormula('IF(1+1=2,"true","false")');
console.log(formatFormula);

```
## Node methods
See basic usage above.
```javascript
Expand All @@ -41,4 +45,4 @@ excelFormulaUtilities is a global variable.
excelFormulaUtilities.formatFormulaHTML(formula) // Use this if you want the output as html.
excelFormulaUtilities.formula2JavaScript(formula)
excelFormulaUtilities.formula2CSharp(formula)
```
```
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -2,7 +2,7 @@
"author": "Josh Bennett (http://joshbennett.me/)",
"name": "excel-formula",
"description": "Methods to beautify an excel formula and convert it to JavaScript or C#",
"version": "1.3.0",
"version": "1.3.1",
"homepage": "http://excelformulabeautifier.com/",
"contributors": [
{
Expand Down

0 comments on commit 6a8f5b2

Please sign in to comment.