You've already forked npm-module-template
mirror of
https://github.com/jakejarvis/npm-module-template.git
synced 2025-06-27 16:15:41 -04:00
reorganize readme
This commit is contained in:
18
README.md
18
README.md
@ -8,8 +8,26 @@ Just a personal boilerplate to my liking for an Node and/or browser module w/ ES
|
||||
|
||||
Probably not very useful to anybody else. 😊
|
||||
|
||||
The rest of the readme from now on is placeholder crap...
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
npm install @jakejarvis/my-module --save-dev
|
||||
# or...
|
||||
yarn add @jakejarvis/my-module --dev
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
import { something } from "@jakejarvis/my-module";
|
||||
|
||||
something({ doSomething: true });
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### something(options?)
|
||||
|
||||
#### options
|
||||
|
7
src/index.d.ts
vendored
7
src/index.d.ts
vendored
@ -9,5 +9,12 @@ export interface Options {
|
||||
|
||||
/**
|
||||
* Does pretty much nothing, contrary to its name.
|
||||
*
|
||||
* @example
|
||||
* ```
|
||||
* import { something } from "@jakejarvis/my-module";
|
||||
*
|
||||
* something({ doSomething: true });
|
||||
* ```
|
||||
*/
|
||||
export function something(options?: Options): void;
|
||||
|
Reference in New Issue
Block a user