[Pkg-javascript-commits] [node-umd] 02/05: Document camel casing of names and removal of disallowed characters

[Bastien Roucariès]

This is an automated email from the git hooks/post-receive script.

rouca pushed a commit to tag 3.0.1
in repository node-umd.

commit 086c52ae09d6a7681e414d158976a0a0875aa727
Author: Ben Drucker <bvdrucker at gmail.com>
Date:   Sat Apr 25 09:26:00 2015 -0400

    Document camel casing of names and removal of disallowed characters
---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index af4544e..3b9b8f7 100644
--- a/README.md
+++ b/README.md
@@ -67,6 +67,16 @@ Options:
  cat my-module.js | umd my-module | uglify-js > my-module.umd.min.js
  ```
 
+## Name Casing and Characters
+
+The `name` passed to `umd` will be converted to camel case (`my-library` becomes `myLibrary`) and may only contain:
+
+* alphanumeric characters
+* $
+* _
+
+The name may not begin with a number. Invalid characters will be stripped. 
+
 ## License
 
   MIT

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-umd.git