Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
malcolm-kee committed Nov 26, 2018
1 parent 8de0483 commit a9c2bc7
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ The filtering rule of the joining functions are:

`joinString` is available with `import joinString from 'join-string'` or `import { joinString } from 'join-string'`, based on your preference.

### `joinClass: (...classNames: any[]) => string`
### `joinClassName: (...classNames: any[]) => string`

`joinClass` is an utility to construct className. It join all its parameter with a space.
`joinClassName` is an utility to construct className. It join all its parameter with a space.

Under the hood, `joinClass` is just `joinString(' ')`.
Under the hood, `joinClassName` is just `joinString(' ')`.

[npm]: https://www.npmjs.com/
[node]: https://nodejs.org
9 changes: 8 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "join-string",
"version": "1.0.0",
"version": "1.0.1",
"description": "A utility for joining strings",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand All @@ -17,6 +17,13 @@
],
"author": "Malcolm Kee <malcolm.keeweesiong@gmail.com>",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/malcolm-kee/join-string"
},
"bugs": {
"url": "https://github.com/malcolm-kee/join-string/issues"
},
"dependencies": {
"typesafe-is": "^1.0.1"
},
Expand Down

0 comments on commit a9c2bc7

Please sign in to comment.