# case_converter_fcc_sample

> Simple tool used to converts text to specific case

Latest version **1.1.1** (published 2019-04-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install case_converter_fcc_sample
pnpm add case_converter_fcc_sample
yarn add case_converter_fcc_sample
bun add case_converter_fcc_sample
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2019-04-16 |
| First published | 2019-04-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jingyi Ding |
| Maintainers | dingjy94 |

## Links

- npm: https://www.npmjs.com/package/case_converter_fcc_sample
- Repository: https://github.com/dingjy94/case_converter_fcc_sample
- Issues: https://github.com/dingjy94/case_converter_fcc_sample/issues
- npm.io page: https://npm.io/package/case_converter_fcc_sample

## Recent versions

- 1.1.1 (latest) — 2019-04-16
- 1.1.0 — 2019-04-16
- 1.0.0 — 2019-04-16

## README

# 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

```javascript
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.

```JSON
"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.
```JSON
"homepage": "https://github.com/<user_name>/<repo_name>#readme"
```

## Publish
1. Sign up on [npm](https://www.npmjs.com/).
2. run `npm login` or `npm adduser`, follow instruction.
3. run `npm publish` to publish your module to npm.
4. go to [npm](https://www.npmjs.com/) 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](https://docs.npmjs.com/updating-your-published-package-version-number)
2. Run `npm publish`.
3. Go to your package page to check the update.

## Some Tips
- [About license](https://opensource.org/licenses)
- [About versioning](https://en.wikipedia.org/wiki/Software_versioning)

---
_Source: https://npm.io/package/case_converter_fcc_sample · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._