Skip to content

nurimba/nb-slug

Repository files navigation

nb-slug

Slug strings

Codeship Status for luiz-simples/nb-slug Code Climate

##How to install?

$ npm install nb-slug --save

##How to use?

var nbSlug = require('nb-slug');
var slug   = nbSlug('MY STRING ÁÉÍÓ_ al}^ ?}^{  (( ))}  dirty and  now ÚŃÑÃÕÇÂÎÔÛ STRING clear')
console.log(slug); //my-string-aeiou-al-dirty-and-now-unnaocaiou-string-clear

##How to contribute?

Environment with:

Make tasks of environment

  • UP and RUN docker environment - $ make run
  • Stop docker environment - $ make stop
  • Destroy docker environment - $ make down

First steps after environment builded

nbSlug@dev:~/src$ npm install
nbSlug@dev:~/src$ npm test