Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dodo committed Sep 22, 2014
1 parent cbfa8f6 commit 7dda5dc
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ print(slug('i ♥ unicode', '_')) // If you prefer something else then `-` as se
slug.charmap[''] = 'freaking love' // change default charmap or use option {charmap:{…}} as 2. argument
print(slug('I ♥ UNICODE').toLowerCase()) // If you prefer lower case
// > i-freaking-love-unicode

print(slug('i <3 unicode'))
// > i-love-unicode
```

## options
Expand All @@ -50,7 +53,9 @@ slug('string', [{options} || 'replacement']);
slug.defaults = {
replacement: '-', // replace spaces with replacement
symbols: true, // replace unicode symbols or not
remove: null, // (optional) regex to remove characters
charmap: slug.charmap, // replace special characters
multicharmap: slug.multicharmap // replace multi-characters
};
```

Expand Down

0 comments on commit 7dda5dc

Please sign in to comment.