Gurmukhi Utils

<!-- Do not modify README.md, instead modify README.hbs -->

<img src="https://raw.githubusercontent.com/shabados/presenter/dev/resources/icon.png" width="128" alt="Shabad OS">

<h1>Gurmukhi Utils</h1>

General utilities for working with Gurmukhi text data. [Try `gurmukhi-utils` in your browser.][runkit-url]

[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Release][release-image]][release-url]
[![Next Release][next-image]][next-url]
[![Test Coverage][coveralls-image]][coveralls-url]

```javascript
const {
  toAscii,
  toUnicode,
  toEnglish,
  stripEndings
} = require( 'gurmukhi-utils' )

const unicodeGurmukhi = 'ਸੋ ਘਰੁ ਰਾਖੁ; ਵਡਾਈ ਤੋਇ ॥੧॥ ਰਹਾਉ ॥'
const asciiGurmukhi = 'so Gru rwKu; vfweI qoie ]1] rhwau ]'

toAscii( unicodeGurmukhi ) // => so Gru rwKu; vfweI qoie ]1] rhwau ]
toUnicode( asciiGurmukhi ) // => ਸੋ ਘਰੁ ਰਾਖੁ; ਵਡਾਈ ਤੋਇ ॥੧॥ ਰਹਾਉ ॥
toEnglish( asciiGurmukhi ) // => so ghar raakh; vaddaaee toie |1| rahaau |
stripEndings( toEnglish( asciiGurmukhi ) ) // => so ghar raakh; vaddaaee toie
```

**Table of Contents**
<!-- toc -->

## Introduction

Gurmukhi Utils is a library for converting, analyzing, and testing gurmukhi strings.

## Usage

Gurmukhi Utils is available as the [`gurmukhi-utils` package][npm-url] on [npm](https://www.npmjs.com/). Want to play around? [Try it out in your browser with RunKit][runkit-url]!

Additionally, the package is available for web use via [unpkg CDN](https://unpkg.com/):
```
<script src="https://unpkg.com/gurmukhi-utils"></script>
```

## 3rd Party Ports

- [onkarjit/GurmukhiUtils](https://github.com/onkarjit/GurmukhiUtils) is a rewrite of Shabad OS's gurmukhi-utils to [C#](https://en.wikipedia.org/wiki/C_Sharp_(programming_language)) for .NET applications

## API

{{#globals}}
### {{>sig-name}}
{{>description~}}
{{>summary~}}
{{>default~}}
{{>returns~}}
{{>params~}}
{{>examples~}}
{{>member-index~}}
{{>separator~}}
{{>members~}}
{{/globals}}

## Community

Get updates on Shabad OS and chat with the project maintainers and community members.

- [![Instagram][instagram-image]][instagram-url] Follow Shabad OS on Instagram
- [![Twitter][twitter-image]][twitter-url] Follow Shabad OS on Twitter.
- [![Chat][chat-image]][chat-url] Join the official Slack channel.

## Contributing

There are multiple ways to contribute whether you are a user or developer. For example:

- [Submit bugs and feature requests][new-issue-url].
- Review documentation and make pull requests for anything from typos to new content.
- Give feedback on the onboarding process to make it easier for others to join the project.

If you're interested in contributing to the source code of Gurmukhi Utils, then please see [Contributing Guidelines](./CONTRIBUTING.md).

## People

The original author and current lead maintainer of Gurmukhi Utils is Harjot Singh ([@harjot1singh](https://github.com/harjot1singh)).

"Thank you!" to [all the volunteers][contributor-url] who've already contributed to Gurmukhi Utils. Additional thanks to:

* Preetcharan S ([@NerdSingh](https://www.instagram.com/nerdsingh/)) and Basics of Sikhi for english pronunciation guidelines
* Dr. Gurpreet S Lehal (Punjabi University, Patiala) for his work in Gurmukhi-Hindi (Devanagri) and Gurmukhi-Shahmukhi (Urdu) transliteration

## Feedback

- Ask a question via [Slack][chat-url]
- [Upvote popular feature requests][upvote-tracker-url] using the thumbs-up/+1 reaction on the first post of a feature request
- Follow [@shabad_os on Instagram](instagram-url) and [@shabad_os on Twitter](twitter-url) and let us know what you think!

## Related Projects

Projects in the Shabad OS ecosystem of free and open source software which use the `gurmukhi-utils` package include:

- [Database](https://github.com/shabados/database)
- [Viewer](https://github.com/shabados/viewer)
- [Presenter](https://github.com/shabados/presenter)
- [Mobile](https://github.com/shabados/mobile)

## Code of Conduct

Please note that this project is released under the Contributor Covenant. By participating in this project you agree to abide by its terms. Our intention is to signal a safe open-source community by welcoming all people to contribute, and pledging in return to value them as whole human beings and to foster an atmosphere of kindness, cooperation, and understanding.

> We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

> We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

> [The Contributor Covenant][contributor-covenant-url]

## License

The Shabad OS Gurmukhi Utils repo is under v3 of the [GPL](LICENSE.md). It is similar to the Golden Rule: do unto others as you would have them do unto you. In exchange for benefitting from the work completed in this repo, others must share their derivative work under v3 of the [GPL](LICENSE.md).

> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

> This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

> You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.


[runkit-url]: https://npm.runkit.com/gurmukhi-utils
[npm-image]: https://img.shields.io/npm/v/gurmukhi-utils.svg
[npm-url]: https://npmjs.org/package/gurmukhi-utils
[downloads-image]: https://img.shields.io/npm/dm/gurmukhi-utils.svg
[downloads-url]: https://npmcharts.com/compare/gurmukhi-utils?minimal=true
[release-image]: https://img.shields.io/circleci/project/github/shabados/gurmukhi-utils/main.svg?label=release
[release-url]: https://circleci.com/gh/shabados/gurmukhi-utils/tree/main
[next-image]: https://img.shields.io/circleci/project/github/shabados/gurmukhi-utils/dev.svg?label=next%20release
[next-url]: https://circleci.com/gh/shabados/gurmukhi-utils/tree/dev
[coveralls-image]: https://img.shields.io/coveralls/github/shabados/gurmukhi-utils.svg?label=test%20coverage
[coveralls-url]: https://coveralls.io/github/shabados/gurmukhi-utils

[instagram-image]: https://img.shields.io/badge/Instagram-%40shabad__os-C13584.svg?logo=instagram&logoColor=white
[instagram-url]: https://www.instagram.com/shabad_os/
[twitter-image]: https://img.shields.io/badge/Twitter-%40shabad__os-1DA1F2.svg?logo=twitter&logoColor=white
[twitter-url]: https://www.twitter.com/shabad_os/
[chat-image]: https://img.shields.io/badge/Chat-Public%20Slack%20Channels-1264a3.svg?logo=slack
[chat-url]: https://chat.shabados.com

[new-issue-url]: https://github.com/shabados/gurmukhi-utils/issues/new
[contributor-url]: https://github.com/shabados/gurmukhi-utils/graphs/contributors
[upvote-tracker-url]: https://github.com/shabados/gurmukhi-utils/issues?q=is%3Aopen+is%3Aissue+label%3A%22Type%3A+Feature%2FEnhancement%22+sort%3Areactions-%2B1-desc
[contributor-covenant-url]: https://www.contributor-covenant.org/version/2/0/code_of_conduct/