Skip to content

Commit 45a6377

Browse files
committed
readme
1 parent ce3c6b4 commit 45a6377

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Typical output (truncated):
5555
]
5656
```
5757

58-
As an alternative to passing in file names/globs (above), you can pass in a source code string.
58+
As an alternative to passing in file names/globs (above), you can pass in one or more source code strings.
5959

6060
```js
6161
import jsdoc from 'jsdoc-api'
@@ -89,15 +89,15 @@ Output:
8989
]
9090
```
9191

92-
Finally, use the `render()` method to invocate jsdoc directly, generating your documentation. See the [example folder](https://github.com/jsdoc2md/jsdoc-api/tree/master/example) for code examples.
92+
Finally, use the `render()` method to invocate jsdoc directly, generating your documentation.
9393

9494
```js
9595
import jsdoc from 'jsdoc-api'
9696

9797
await jsdoc.render({ files: ['index.js', 'lib/*.js'], destination: 'jsdoc-output' })
9898
```
9999

100-
See the [API documentation](https://github.com/jsdoc2md/jsdoc-api/blob/master/docs/api.md) for further details.
100+
See the [API documentation](https://github.com/jsdoc2md/jsdoc-api/blob/master/docs/api.md) for further details. See the [example folder](https://github.com/jsdoc2md/jsdoc-api/tree/master/example) for code examples.
101101

102102
* * *
103103

0 commit comments

Comments
 (0)