From 1a1b1eb5f99bb6f6883da46a992275a3f083fda2 Mon Sep 17 00:00:00 2001
From: Jake Jarvis <jake@jarv.is>
Date: Wed, 29 Sep 2021 20:53:10 -0400
Subject: [PATCH] reorganize readme

---
 README.md      | 18 ++++++++++++++++++
 src/index.d.ts |  7 +++++++
 2 files changed, 25 insertions(+)

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;