ellojess / slug-maker

https://www.npmjs.com/package/slug-maker

slug-maker

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

NPM package that cleans and sluggifies any string, see the live package here

Built With

• JavaScript
• NPM

Getting Started

To get the package installed in your project, follow these simple steps.

Prerequisites

• NPM

Installation

1. Install this NPM package in your exisitng node application

   npm install slug-maker

Usage

Case to Slug

A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id .

You use a slug when you want to refer to an item while preserving the ability to see, at a glance, what the item is, and should be a unique part of a URL.

Project File

const {makeSlug} = require('slug-maker');

console.log(makeSlug("TestING,   HoW I$s Th1s L00KiNg?!?!?!?!@#$#@*&"));

Terminal

$ node index.js 

Returns

$ testing-how-is-th1s-l00king

Notice that all non-alphanumerical characters have been removed and extra spaces have been handled.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request using this template

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jessica Trinh - @ellojesss - [e-mail]

Project Link: https://www.npmjs.com/settings/ellojess/packages