osis2json v0.1.4

Motivation

Bogged down with hairy OSIS XML, and want something more lightweight?

This is the library for you!

Why OSIS?

Sword is the most widely used XML schema for publishing Bibles electronically.

You can read more about it on Wikipedia.

Why osis2json?

Traditionally, applications have interacted with OSIS XML through Sword modules, and the corresponding libraries for parsing those.

There are two official libraries for reading Sword modules: Java and C++. Neither are particularly friendly to newcomers, and lack good documentation.

"Filters" within these libraries can convert XML to HTML. Which is great if you're building an old school, static HTML website, not so great if you're trying to use modern frontend tools like React, Vue, or Angular to build modern web or mobile apps.

osis2json was created as a modern solution for building Bible apps and websites using pure Javascript.

Don't be afraid of Typescript! It compiles down to vanilla Javascript, so you can run it anywhere.

Getting Started

To install in your project:

yarn add osis2json

or, alternatively:

npm install osis2json --save

Check the test cases for a full example of an OSIS XML verse.

It must begin, and end, with the <xml> tag.

const osis2json = require('osis2json');
const verseXML = //JS string
const verseJson = osis2json(verseXML);