Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/switer/ciment
Browse files Browse the repository at this point in the history
  • Loading branch information
switer committed Oct 9, 2013
2 parents 2964783 + 39ae18e commit 81adac4
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
@@ -1,10 +1,10 @@
ciment
========

`ciment` is a javascript comments library for generating comment string rapidly.
`ciment` is a library for generating comment-String rapidly. Include javascript, CSS and HTML commnets manipulation.

```javascript
var comment = var comment = require('ciment');
var comment = require('ciment');

// Comment module methods
comment.single('hello world'); // result: "// hello world"
Expand All @@ -14,15 +14,16 @@ comment.block('hello world'); // result: "/* hello world */"
'hello world'.single(); // result: "// hello world"
'hello world'.block(); // result: "/* hello world */"

'hello world'.block().decomment(); // result: "hello world"
```
## Install
For [node](http://nodejs.org) with [npm](http://npmjs.org):

```bash
npm install comment
npm install ciment
```

And use with `var comment = require("comment")`
And use with `var comment = require("ciment")`

## API

Expand Down

0 comments on commit 81adac4

Please sign in to comment.