Readme now has infos in it

parent bf38b1bb
# isCamelCase
This small package can check if a given string or a file is in camelCase style.
# install
#### Yarn
```c
yarn add iscamelcase
```
#### NPM
```
npm install iscamelcase
```
# example
At first we have to require the package:
```js
const isCamelCase = require("iscamelcase");
```
There are two options to compare a given string. Both return a boolean.
##### string is a normal value
In this case we can use the checkString function:
```js
console.log(isCamelCase.checkString("foo"));
```
##### string is a file
In this case we should use the checkFile function:
```js
console.log(isCamelCase.checkString("foo.bar"));
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment