@texttree/bible-crossref v0.0.5

About The Project

A small library that returns cross-references for a selected verse or chapter.

Purpose

Make an easy way to get cross references.

Problem

I didn't find any js libraries for getting cross-references, although there are large open bases in the public domain.

(back to top)

Built With

• https://github.com/josephilipraja/bible-cross-reference-json/

(back to top)

Getting Started

Installation

Add the library to your app

• yarn

yarn add @texttree/bible-crossref

• npm

npm install @texttree/bible-crossref

(back to top)

Usage

• import

import { getByBCV, getByBC } from '@texttree/bible-crossref';

• require

const bibleCrossref = require('@texttree/bible-crossref');

There are two methods in the library:

• getByBCV({book, chapter, verse}) - getting cross-references by verse
• getByBC({book, chapter}) - getting cross-references by chapter

You can also use the api that uses this library to check.

https://crossref.texttree.org/crossref/gen.34.19

https://crossref.texttree.org/crossref/gen.34

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Guidelines for external contributions.

You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

If you would like to fork the repo and create a pull request.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/texttree/bible-crossref

(back to top)