https://github.com/brothersincode/f2f

Farsi to Finglish, a Persian transliterator
https://github.com/brothersincode/f2f

farsi javascript persian persian-transliterator transliteration

Last synced: 9 months ago
JSON representation

Farsi to Finglish, a Persian transliterator

• Host: GitHub
• URL: https://github.com/brothersincode/f2f
• Owner: brothersincode
• License: mit
• Created: 2017-07-14T03:24:00.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2025-04-14T07:42:18.000Z (about 1 year ago)
• Last Synced: 2025-09-05T11:15:16.908Z (10 months ago)
• Topics: farsi, javascript, persian, persian-transliterator, transliteration
• Language: JavaScript
• Size: 7.81 KB
• Stars: 27
• Watchers: 2
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# F2F

Farsi to Finglish, a Persian transliterator

A JavaScript port of [aminmarashi/onezero-f2f](https://github.com/aminmarashi/onezero-f2f) by [Amin Marashi](https://github.com/aminmarashi)

[![NPM version](https://img.shields.io/npm/v/f2f.svg?style=flat-square)](https://www.npmjs.com/package/f2f)

[![GitHub issues](https://img.shields.io/github/issues/brothersincode/f2f.svg?style=flat-square)](https://github.com/brothersincode/f2f/issues)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/brothersincode/f2f/master/LICENSE)

[![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square)](https://github.com/Flet/semistandard)

## Install

``` bash

npm install f2f

```

## Usage

```js

var f2f = require('f2f');

var F2F = new f2f();

F2F.simplef2f('ثقلین'); // Outputs: "saghlin"

F2F.simplef2f('قسطنطنیه'); // Outputs: "ghastntnih"

```

### Browser

```html

  var F2F = new f2f();

  alert(F2F.simplef2f("قسطنطنیه"));

```

#### F2F.simplef2f([text])

##### text

Type: `string`

String in Persian to be converted.

## License

This software is licensed under the MIT License. [View the license](LICENSE).