slug - npm Package Compare versions

Comparing version 0.4.0 to 0.4.1

package.json

 { "name": "slug"
 , "description": "slugifies even utf-8 chars!"
-, "version": "0.4.0"
+, "version": "0.4.1"
 , "homepage": "https://github.com/dodo/node-slug"
@@ -18,2 +18,5 @@ , "author": "dodo (https://github.com/dodo)"
     "coffee-script": ">= 1.1.2"}
+, "licenses" : [
+    { "type": "MIT" ,
+      "url": "http://github.com/dodo/node-slug/raw/master/LICENSE"} ]
 }

README.md

@@ -1,5 +0,17 @@
-# slugify string
+# [slug](https://github.com/dodo/node-slug)
 
 slugifies every string, even when it contains unicode!
 
+Make strings url-safe.
+
+- Comprehensive tests
+- No dependencies (except the unicode table)
+- Not in coffee-script (except the tests lol)
+- Coerces foreign symbols to their english equivalent
+- Works in browser (window.slug) and AMD/CommonJS-flavoured module loaders (except the unicode symbols unless you use browserify but who wants to download a ~2mb js file, right?)
+
+```
+npm install slug
+```
+
 ## example
@@ -17,4 +29,24 @@
  'i-freaking-love-unicode'
+> slug('unicode ♥ is ☢') # yes!
+ 'unicode-love-is-radioactive'
 ```
 
-[![Build Status](https://secure.travis-ci.org/dodo/node-slug.png)](http://travis-ci.org/dodo/node-slug)
+## options
+
+```javascript
+// options is either object or replacement (sets options.replacement)
+slug('string', [{options} || 'replacement']);
+```
+
+```javascript
+slug.defaults = {
+    replacement: '-',      // replace spaces with replacement
+    symbols: true,         // replace unicode symbols or not
+    charmap: slug.charmap, // replace special characters
+};
+```
+
+[![Build Status](https://secure.travis-ci.org/dodo/node-slug.png)](http://travis-ci.org/dodo/node-slug)
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/dodo/node-slug/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

22851

increased by13.74%

Number of package files

15

increased by15.38%

Number of lines in readme file

52

increased by173.68%

Number of medium supply chain risk alerts

4

decreased by-20%

No dependency changes