diff --git a/README.md b/README.md index ac9c1ca..ae2e3d5 100644 --- a/README.md +++ b/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 diff --git a/src/index.d.ts b/src/index.d.ts index 6e7d598..0e225fb 100644 --- a/src/index.d.ts +++ b/src/index.d.ts @@ -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;