Skip to content
This repository was archived by the owner on Nov 27, 2018. It is now read-only.

Latest commit

 

History

History
35 lines (24 loc) · 1.3 KB

README.md

File metadata and controls

35 lines (24 loc) · 1.3 KB

jsFile-txt Build Status Coverage Status

Engine for jsFile library to read all files as simple plain-text documents (.txt)

⚠️ This project is deprecated in favour of https://github.com/file2html/file2html

Installation

via NPM

You can install a jsFile-txt package very easily using NPM. After installing NPM on your machine, simply run:

$ npm install jsfile-txt

with Git

You can clone the whole repository with Git:

$ git clone git://github.com/jsFile/jsFile-txt.git

from latest version

Also you can download the latest release of TXT engine and include built files to your project.

##Usage

import JsFile from 'JsFile';
import JsFileTxt from 'jsfile-txt';

const jf = new JsFile(file, options);

file - a plain-text file. You may find information about options and jsFile in documentation