Skip to content

Latest commit

 

History

History
29 lines (16 loc) · 558 Bytes

README.md

File metadata and controls

29 lines (16 loc) · 558 Bytes

shortme

Create a short slug version from your text input. This could be useful for your filenames or creative slugs.

Installation

  • Run npm install shortme --save

Usage

const shortme = require("shortme");
shortme("Your Text Input", options) // Return "yti"

options Type: Object

delimiterChar Type: String, Default: "_"

Define delimiter char sign

maxCharLength Type: Number, Default: 16

Define max length from returning output String

Demo

Live demo available on http://projects.bminusg.de/shortme/