Skip to content

Latest commit

 

History

History
108 lines (70 loc) · 2.26 KB

README.md

File metadata and controls

108 lines (70 loc) · 2.26 KB
Raw

Beta Code JS

Converts Greek Beta Code to Greek characters and vice versa.

Try it Out

https://apps.perseids.org/beta-code/

Installation

yarn add beta-code-js

or

npm install beta-code-js

(See project on npm)

Usage

import { greekToBetaCode, betaCodeToGreek } from 'beta-code-js';

greekToBetaCode('χαῖρε ὦ κόσμε');
// => 'xai=re w)= ko/sme'

betaCodeToGreek('mh=nin a)/eide qea\\ *phlhi+a/dew *)axilh=os');
// => 'μῆνιν ἄειδε θεὰ Πηληϊάδεω Ἀχιλῆος'

or

var bc = require('beta-code-js');

bc.greekToBetaCode('χαῖρε ὦ κόσμε');
// => 'xai=re w)= ko/sme'

bc.betaCodeToGreek('mh=nin a)/eide qea\\ *phlhi+a/dew *)axilh=os');
// => 'μῆνιν ἄειδε θεὰ Πηληϊάδεω Ἀχιλῆος'

With additional mappings

import { betaCodeToGreek } from 'beta-code-js';

betaCodeToGreek('f2a/nac', { f2: 'ϝ' })
// => 'ϝάναξ'

Usage in Browser

<html>
<script src="bundle/beta-code.js"></script>

<body>
  <script>
    console.log(BetaCode.greekToBetaCode('χαῖρε ὦ κόσμε'));
    // => 'xai=re w)= ko/sme'

    console.log(BetaCode.betaCodeToGreek('mh=nin a)/eide qea\\ *phlhi+a/dew *)axilh=os'));
    // => 'μῆνιν ἄειδε θεὰ Πηληϊάδεω Ἀχιλῆος'
  </script>
</body>
</html>

Setup

yarn install

Tests

yarn test

Building for Browser

yarn bundle

Updating JSON

git subtree pull --prefix vendor/beta-code-json/ https://github.com/perseids-tools/beta-code-json master --squash

In the case of a merge conflict:

git checkout --theirs vendor/beta-code-json/
git add vendor/beta-code-json
git commit

Publishing

  • Bump version in package.json
  • Run yarn bundle
  • Commit and push to GitHub
  • On GitHub, create a new release
  • Run npm publish

Notes

For the mappings between Beta Code and Unicode, see https://github.com/perseids-tools/beta-code-json. For an example of this package being used, see https://github.com/perseids-project/beta-code-converter-js.