Giter Club home page Giter Club logo

rune-converter's Introduction

Build Status

rune-converter

a small node package for converting text to the runic alphabet

Installation

npm install rune-converter

Usage

  import transcribe from 'rune-converter'

Functions

transcribe(str, options)

transcribe() is the default function to convert a given string to elder futhark.

Arguments

  • str (String) - the string you wish to convert
  • options (Object) - options that determine the conversion of the string
    • punctuation - determines what symbol to transcribe ' . ' to

      key value
      cross (default) แ›ญ
      double แ›ฌ
      single แ›ซ
    • spacing - determines what symbol to transcribe spacing to

      key value
      normal whitespace
      cross แ›ญ
      double (default) แ›ฌ
      single แ›ซ

Examples

  var str = 'Lorem ipsum dolor sit amet.'

  transcribe(str) // แ›šแ›Ÿแšฑแ›–แ›—แ›ฌแ›แ›ˆแ›‹แšขแ›—แ›ฌแ›žแ›Ÿแ›šแ›Ÿแšฑแ›ฌแ›‹แ›แ›แ›ฌแšจแ›—แ›–แ›แ›ญ

  transcribe(str, { punctuation: 'single' }) // แ›šแ›Ÿแšฑแ›–แ›—แ›ฌแ›แ›ˆแ›‹แšขแ›—แ›ฌแ›žแ›Ÿแ›šแ›Ÿแšฑแ›ฌแ›‹แ›แ›แ›ฌแšจแ›—แ›–แ›แ›ซ

  transcribe(str, { spacing: 'normal' }) // แ›šแ›Ÿแšฑแ›–แ›— แ›แ›ˆแ›‹แšขแ›— แ›žแ›Ÿแ›šแ›Ÿแšฑ แ›‹แ›แ› แšจแ›—แ›–แ›แ›ญ

rune-converter's People

Contributors

fbosch avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

lazuraslong

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.