# deumlaut

> Remove diacricts from your local language and create universial strings.

Latest version **0.0.4** (published 2021-10-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install deumlaut
pnpm add deumlaut
yarn add deumlaut
bun add deumlaut
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2021-10-10 |
| First published | 2021-10-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kaan Gökdemir |
| Maintainers | kaangokdemir |

## Links

- npm: https://www.npmjs.com/package/deumlaut
- npm.io page: https://npm.io/package/deumlaut

## Recent versions

- 0.0.4 (latest) — 2021-10-10
- 0.0.3 — 2021-10-10
- 0.0.2 — 2021-10-10
- 0.0.1 — 2021-10-10

## README

# Deumlaut

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) [![npm package](https://img.shields.io/npm/v/deumlaut.svg)](https://www.npmjs.org/package/deumlaut) [![downloads](https://img.shields.io/npm/dt/deumlaut.svg)](https://www.npmjs.com/package/deumlaut) [![size](https://img.shields.io/bundlephobia/minzip/deumlaut)](https://www.npmjs.com/package/deumlaut)

> A lightweight zero dependency libray to replace [Umlauts (Diacritics)](<https://en.wikipedia.org/wiki/Diaeresis_(diacritic)/>) from your strings.

<img src="https://raw.githubusercontent.com/kaangokdemir/deumlaut/master/static/logo.jpeg" width="200" height="200">

```bash
npm i deumlaut

# or

yarn add deumlaut
```

## Usage

```javascript
const { deumlaut } = require('deumlaut')

// or

import { deumlaut } from 'deumlaut'

deumlaut('Tschüss') // Tschuess
deumlaut('Çarşı', 'tr') // Carsi

//  For more examples, you can check the "tests" folder.
```

## Parameters

| Position | Name    | Description                                   | Required | Type                     |
| -------- | ------- | --------------------------------------------- | -------- | ------------------------ |
| 1        | Text    | Text to remove diacritics                     | `true`   | `string`                 |
| 2        | Locale  | Your language to parse                        | `false`  | `'de'` or `'tr'`         |
| 3        | Options | Deumlaut options. See Options for the details | `false`  | `DeumlautOptions` object |

## Options

| Name         | Type      | Default Value | Description                            |
| ------------ | --------- | ------------- | -------------------------------------- |
| `capitalize` | `boolean` | `false`       | Capitalizes the diacritic equilavants. |

## Supported Languages

- Currently only German and Turkish are supported.

## Contributing

Please check [CONTRIBUTING.md](https://raw.githubusercontent.com/kaangokdemir/deumlaut/master/CONTRIBUTING.md)

## TODO

- Improve Documentation
- Add More Unit tests
- Improve support for other languages

## Contributors

Kaan Gökdemir - Author ([@kaangokdemir](https://linkedin.com/kaan-gokdemir)) - [kaangokdemir.com](https://kaangokdemir.com)

## License

[MIT](https://opensource.org/licenses/MIT)

---
_Source: https://npm.io/package/deumlaut · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._