https://github.com/palashmon/acronymer

🚀 Transform strings into memorable acronyms
https://github.com/palashmon/acronymer

abbreviation acronym acronyms generate javascript library string strings text transform

Last synced: about 1 month ago
JSON representation

🚀 Transform strings into memorable acronyms

• Host: GitHub
• URL: https://github.com/palashmon/acronymer
• Owner: palashmon
• License: mit
• Created: 2024-04-06T11:53:17.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-11-15T18:52:30.000Z (about 1 month ago)
• Last Synced: 2024-11-15T19:35:14.776Z (about 1 month ago)
• Topics: abbreviation, acronym, acronyms, generate, javascript, library, string, strings, text, transform
• Language: JavaScript
• Homepage:
• Size: 37.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# acronymer

> Transform strings into memorable acronyms

![CI](https://github.com/palashmon/acronymer/actions/workflows/main.yml/badge.svg)

[![npm version](https://img.shields.io/npm/v/acronymer.svg)](http://npm.im/acronymer)

[![npm downloads](https://img.shields.io/npm/dm/acronymer.svg)](http://npm.im/acronymer)

Transform strings into memorable acronyms with ease using the `acronymer` npm package. This lightweight and efficient tool simplifies the process of generating acronyms from input strings, making them concise and easy to remember.

### How It Can Be Useful

- Abbreviating long phrases or technical terms in code or documentation.

- Creating memorable identifiers for variables, functions, or entities.

- Compressing data while maintaining readability.

- Enhancing user experience by simplifying complex terminology.

- Streamlining communication by providing concise representations of concepts or ideas.

## Install

```sh

npm install acronymer

```

## Usage

```js

import acronymer from 'acronymer';

// Test cases

acronymer('Cascading Style Sheets')         // 'CSS'

acronymer('Behavior-driven design')         // 'BDD'

acronymer('HyperText Markup Language!')     // 'HTML'

acronymer('JavaScript Object Notation')     // 'JSON'

acronymer('CASCADING Style Sheets')         // 'CSS'

acronymer('HyperText and Markup Language')  // 'HTML'

acronymer('A B C')                          // 'ABC'

acronymer('')                               // ''

acronymer('1234567890!@#$%^&*()')           // ''

```

## API

### acronymer(text)

#### text

Type: `string`

The text to be transformed into an acronym. It must be a non-empty **string** containing at least one alphanumeric character. It will throw an error if the input is not a string.

## License

MIT © [Palash Mondal](https://github.com/palashmon)