jake/npm-module-template
1
Fork 0
mirror of https://github.com/jakejarvis/npm-module-template.git synced 2025-06-27 16:15:41 -04:00
Code Releases Activity

reorganize readme

Browse Source
This commit is contained in:
Jake Jarvis
2021-09-29 20:53:10 -04:00
parent 3a3a1efd32
commit 1a1b1eb5f9
2 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -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. 😊 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 ## Usage
```js
import { something } from "@jakejarvis/my-module";
something({ doSomething: true });
```
## API
### something(options?) ### something(options?)
#### options #### options

7
src/index.d.ts vendored
View File

@ -9,5 +9,12 @@ export interface Options {
/** /**
* Does pretty much nothing, contrary to its name. * Does pretty much nothing, contrary to its name.
*
* @example
* ```
* import { something } from "@jakejarvis/my-module";
*
* something({ doSomething: true });
* ```
*/ */
export function something(options?: Options): void; export function something(options?: Options): void;