Sanscript.rb

Gem Version Dependency Status Build Status Test Coverage Code Climate Inline docs

This gem is starting off as a mostly-straightforward port of learnsanskrit.org's Sanscript.js, and will go from there. It also incorporates transliteration scheme detection based on learnsanskrit.org's Detect.js.

Installation

Add this line to your application's Gemfile:

gem 'sanscript'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sanscript

Usage

You can access detection through Sanscript.detect(text) and transliteration through Sanscript.transliterate(text, from, to).

Documentation is provided in YARD format and available online at rubydoc.info.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ubcsanskrit/sanscript. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.