case_converter_fcc_sample v1.1.1

Case Converter FCC

This is a prototype of fcc curriculum project to teach how to build, use and publish npm module. This module itself provide methods to covert string to specify case.

Install

npm install case_converter_fcc_sample

Usage

const caseConverter = require('./index');

const str = 'hello free Code Camp!';
console.log(caseConverter.getUpperCase(str)); // HELLO FREE CODE CAMP!
console.log(caseConverter.getLowerCase(str)); // hello free code camp!
console.log(caseConverter.getProperCase(str)); // Hello Free Code Camp!
console.log(caseConverter.getSentenceCase(str)) // Hello free code camp!

License

The MIT License

How to build npm module

Create your module (package)

1. Create a directory for your module.
2. In package root directroy, run npm init, and follow the instruction to generate package.json.
3. Creat a README.md file to explain your package.
4. Write your code and export the methods you want user to call.

Add Github Respository (Optional)

1. You can add your github respository into package.json. The url should be a publicly available url that can be handed directly to a VCS program without any modification.

"repository": {
  "type" : "git",
  "url" : "https://github.com/<user_name>/<repo_name>.git"
}

// or you can use shortcut
"repository": "github:user/repo"

2. You can also set the repository page as your module's homepage.

"homepage": "https://github.com/<user_name>/<repo_name>#readme"

Publish

1. Sign up on npm.
2. run npm login or npm adduser, follow instruction.
3. run npm publish to publish your module to npm.
4. go to npm to check your published package!

Usage

1. run npm install module_name to download and install the package.
2. Whenever your need to use the module use require to import the module.

Update

1. Run npm version <update_type> to change the version. see more
2. Run npm publish.
3. Go to your package page to check the update.

Some Tips

• About license
• About versioning