Skip to content
This repository has been archived by the owner on Dec 5, 2017. It is now read-only.

Commit

Permalink
README update [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
SheetJSDev committed May 16, 2014
1 parent c6e8162 commit 17f5ff9
Showing 1 changed file with 26 additions and 21 deletions.
47 changes: 26 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@ Supported Formats:
| XML (2003/2004, basic) | JS-XLS |

Output formats:

- XML and HTML work with [Excel Web Query](http://office.microsoft.com/en-us/excel-help/get-and-analyze-data-from-the-web-in-excel-HA001054848.aspx)
- CSV (and other delimited formats such as TSV)
- JSON
- Formulae list (e.g. `A1=NOW()`, `A2=A1+3`)
- XLSX / XLSM work with iOS Numbers and Excel

## Installation

Expand All @@ -34,16 +36,18 @@ var J = require('j');

`J.readFile(filename)` opens the file specified by filename and returns an array
whose first object is the parsing object (XLS or XLSX) and whose second object
is the parsed file.
is the parsed file.

`J.utils` has various helpers that expect an array like those from readFile:

- `to_csv(w) / to_dsv(w, delim)` will generate CSV/DSV respectively
- `to_json(w)` will generate JSON row objects
- `to_html(w)` will generate simple HTML tables
- `to_xml(w)` will generate simple XML
- `to_xml(w)` will generate simple XML
- `to_xlsx(w)` will generate XLSX workbooks
- `to_xlsm(w)` will generate XLSM workbooks

## CLI Tool
## CLI Tool

The node module ships with a binary `j` which has a help message:

Expand All @@ -54,24 +58,25 @@ $ j --help
Options:
-h, --help output usage information
-V, --version output the version number
-f, --file <file> use specified workbook
-s, --sheet <sheet> print specified sheet (default first sheet)
-l, --list-sheets list sheet names and exit
-S, --formulae print formulae
-j, --json emit formatted JSON rather than CSV (all fields text)
-J, --raw-js emit raw JS object rather than CSV (raw numbers)
-X, --xml emit XML rather than CSV
-H, --html emit HTML rather than CSV
-F, --field-sep <sep> CSV field separator
-R, --row-sep <sep> CSV row separator
--dev development mode
--read read but do not print out contents
-q, --quiet quiet mode
Support email: dev@sheetjs.com
Web Demo: http://oss.sheetjs.com/
-h, --help output usage information
-V, --version output the version number
-f, --file <file> use specified workbook
-s, --sheet <sheet> print specified sheet (default first sheet)
-l, --list-sheets list sheet names and exit
-o, --output <file> output to specified file
-M, --xlsm emit XLSM to <sheetname> or <file>.xlsm
-X, --xlsx emit XLSX to <sheetname> or <file>.xlsx
-S, --formulae print formulae
-j, --json emit formatted JSON (all fields text)
-J, --raw-js emit raw JS object (raw numbers)
-X, --xml emit XML
-H, --html emit HTML
-F, --field-sep <sep> CSV field separator
-R, --row-sep <sep> CSV row separator
-n, --sheet-rows <num> Number of rows to process (0=all rows)
--dev development mode
--read read but do not print out contents
-q, --quiet quiet mode
```


Expand Down

0 comments on commit 17f5ff9

Please sign in to comment.