Skip to content

Latest commit

 

History

History
191 lines (126 loc) · 3.86 KB

README.md

File metadata and controls

191 lines (126 loc) · 3.86 KB
Raw

SampleTwo

Bible Indexer

A comprehensive library for querying bible content and getting cascading dropdowns for loading books of the bible, chapters and associated verses.

Author

Badges

MIT License

stable release version: version

Nuget package downloads: downloads

Features

  • Get a bible verse
  • Get a book of the bible
  • Get all verses in a chapter
  • Generate a random bible verse
  • Get all chapters in a book of the bible
  • Get a list of all books and their abbreviations in the bible (For creating dropdowns)
  • Get all verses where a specified query string occurs in the bible
  • Get a list of numbers representing all chapters in a book of the bible (for creating dropdowns)
  • Get a list of numbers representing all verses in a chapter (for creating dropdowns)

Tech Stack

C#, .Net6.0, .NetStandard2.1,

How Do I Get Started

First, install NuGet. Then, install BibleIndexer from the package manager console:

   NuGet\Install-Package BibleIndexer.Query -Version 1.1.1

Or from the .NET CLI as:

   dotnet add package BibleIndexer.Query --version 1.1.1

Finally, import into the file:

   using BibleIndexerV2;

Doc Reference

Get chapters in the Book Of a bible

  • Sample Usage:
   await BibleService.GetChaptersInABookOfTheBible(bookName);
  • Input
Parameter Type Description
bookName string Required. The name of the book of the bible e.g genesis
  • Output
Type
Task<ChaptersResponse?>

Generate a random bible verse

  • Sample Usage
   await BibleService.GenerateRandomBibleVerse();
  • Output
Type
Task<BibleVerseResponse?>

Get all books of the bible

  • Sample Usage
   await BibleService.GetAllBooksOfTheBible();
  • Output
Type
Task<object>

Get all verses and verses dropdown in a chapter of the bible

  • Sample Usage
   await BibleService.GetAllVersesInAChapterOFTheBible(request);
  • Input
Parameter Type
request GetBibleVerseRequest
  • Output
Type
Task<VersesResponse?>

Get a book of the bible

  • Sample Usage
   await BibleService.GetBookOfTheBible(bookName);
  • Input
Parameter Type Description
bookName string Required. The name of the book of the bible e.g genesis
  • Output
Type
Task<BlobResponse?>

Get a bible verse

  • Sample Usage
   await BibleService.GetBibleVerse(request);
  • Input
Parameter Type
request GetBibleVerseRequest
  • Output
Type
Task<BibleVerseResponse?>

Search the bible

  • Sample Usage
   await BibleService.SearchBible(query);
  • Input
Parameter Type Description
query string Required. Query param for the search
  • Output
Type
Task<IEnumerable<BibleVerseResponse>>

Roadmap

  • Robust ReadMe

  • AI integration

  • Additional features

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code_of_conduct.md.