Skip to content

Commit 44ba2f3

Browse files
committed
Add README
1 parent 5dc9471 commit 44ba2f3

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Help
2+
3+
> REPL help texts.
4+
5+
6+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
7+
8+
<section class="intro">
9+
10+
</section>
11+
12+
<!-- /.intro -->
13+
14+
<!-- Package usage documentation. -->
15+
16+
<section class="usage">
17+
18+
## Usage
19+
20+
``` javascript
21+
var help = require( '@stdlib/repl/help' );
22+
```
23+
24+
#### help()
25+
26+
Returns an `object` containing REPL help texts.
27+
28+
``` javascript
29+
var o = help();
30+
// returns {...}
31+
```
32+
33+
</section>
34+
35+
<!-- /.usage -->
36+
37+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
38+
39+
<section class="notes">
40+
41+
</section>
42+
43+
<!-- /.notes -->
44+
45+
<!-- Package usage examples. -->
46+
47+
<section class="examples">
48+
49+
## Examples
50+
51+
<!-- TODO: better example -->
52+
53+
``` javascript
54+
var help = require( '@stdlib/repl/help' );
55+
56+
var o = help();
57+
console.log( o );
58+
// => {...}
59+
```
60+
61+
</section>
62+
63+
<!-- /.examples -->
64+
65+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
66+
67+
<section class="references">
68+
69+
</section>
70+
71+
<!-- /.references -->
72+
73+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
74+
75+
<section class="links">
76+
77+
</section>
78+
79+
<!-- /.links -->

0 commit comments

Comments
 (0)