Skip to content

Commit

Permalink
rename package
Browse files Browse the repository at this point in the history
  • Loading branch information
ichiriac committed Jan 7, 2017
1 parent 0356720 commit 6b01724
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ notifications:
on_failure: always
on_start: never
script: npm run cover
after_success: cat /home/travis/build/glayzzle/docblock-parser/coverage/lcov.info | /home/travis/build/glayzzle/docblock-parser/node_modules/coveralls/bin/coveralls.js
after_success: cat /home/travis/build/glayzzle/doc-parser/coverage/lcov.info | /home/travis/build/glayzzle/doc-parser/node_modules/coveralls/bin/coveralls.js
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ annotations under an structured syntax tree.
# Install

```sh
npm install parsedoc --save
npm install doc-parser --save
```

And simple usage :

```js
var ParseDoc = require('parsedoc');
var reader = new ParseDoc();
var DocParser = require('doc-parser');
var reader = new DocParser();
var data = reader.parse('/** @hello world */');
```

Expand Down Expand Up @@ -59,7 +59,17 @@ var data = reader.parse('/** @hello world */');
# AST structure

```js

{
kind: 'doc',
summary: 'Some description retrieved from the first line of the coment',
body: [
{
kind: 'return',
type: 'void',
description: 'Some extra informations'
}
]
}
```

# Misc
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "parsedoc",
"name": "doc-parser",
"version": "0.2.2",
"description": "Parses docblocks comments",
"main": "src/index.js",
Expand All @@ -9,7 +9,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/glayzzle/docblock-parser.git"
"url": "git+https://github.com/glayzzle/doc-parser.git"
},
"xo": {
"space": 2,
Expand All @@ -31,9 +31,9 @@
"author": "Ioan CHIRIAC",
"license": "BSD-3-Clause",
"bugs": {
"url": "https://github.com/glayzzle/docblock-parser/issues"
"url": "https://github.com/glayzzle/doc-parser/issues"
},
"homepage": "https://github.com/glayzzle/docblock-parser#readme",
"homepage": "https://github.com/glayzzle/doc-parser#readme",
"devDependencies": {
"coveralls": "^2.11.15",
"grunt": "^1.0.1",
Expand Down

0 comments on commit 6b01724

Please sign in to comment.