Permalink
Browse files

Doc for the deprecate command

  • Loading branch information...
isaacs committed Nov 6, 2010
1 parent 65ded5a commit 85159f83d0467c51eadace12428e6aafea5726d7
Showing with 18 additions and 0 deletions.
  1. +18 −0 doc/deprecate.md
View
@@ -0,0 +1,18 @@
+npm-deprecate(1) -- Deprecate a version of a package
+====================================================
+
+## SYNOPSIS
+
+ npm deprecate <pkg>[@<version>] <message>
+
+## DESCRIPTION
+
+This command will update the npm registry entry for a package, providing
+a deprecation warning to all who attempt to install it.
+
+It works on version ranges as well as specific versions, so you can do
+something like this:
+
+ npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
+
+Note that you must be the package owner to deprecate something.

0 comments on commit 85159f8

Please sign in to comment.