Barebones api introduction

docs/.vuepress/config.ts

@@ -6,9 +6,11 @@ const config = {
 
 	themeConfig: {
 		repo: "Batterii/fixture-riveter",
-
 		docsDir: "docs",
-		editLinkPattern: ":repo/edit/:branch/:path",
+
+		editLink: false,
+		lastUpdated: false,
+		contributors: false,
 
 		navbar: [
 			{

docs/api/README.md

@@ -1,3 +1,36 @@
-# API
+---
+sidebar: auto
+title: API
+---
 
-This will discuss every inch of the internal API.
+# Exports
+
+`fixture-riveter` exposes a number of classes and an instance of the primary class `FixtureRiveter` for easy consumption. Each of these exports is discussed below.
+
+```typescript
+import {
+	// primary export
+	fr,
+	FixtureRiveter,
+
+	// ORM adapters
+	Adapter,
+	DefaultAdapter,
+	ObjectionAdapter,
+	SequelizeAdapter,
+
+	// object creation strategies
+	Strategy,
+	AttributesForStrategy,
+	BuildStrategy,
+	CreateStrategy,
+} from "fixture-riveter";
+```
+
+## `fr` and `FixtureRiveter`
+
+The primary method for consuming the library. (The `FixtureRiveter` constructor is exposed as well, in case you need to instantiate it yourself). The functionality is discussed further in [fr api](/api/fr/).
+
+## `Adapter`
+
+Instead of writing ORM-specific code for instancing and persisting created objects, we rely on this interface (and the following default implementation of it). This handles the two aforementioned aspects of `factory_bot`: creating an instance of a given model, and then persisting it to the database.

docs/api/fr/README.md

@@ -0,0 +1,7 @@
+---
+sidebar: auto
+---
+
+# `fr` instance
+
+wow

docs/changelog/README.md

@@ -1,3 +1,7 @@
+---
+sidebar: auto
+---
+
 # Changelog
 
 All notable changes to this project will be documented in this file.

lib/index.ts

@@ -1,13 +1,28 @@
+import {FixtureRiveter} from "./fixture-riveter";
+
 import {Adapter} from "./adapters/adapter";
 import {DefaultAdapter} from "./adapters/default-adapter";
 import {ObjectionAdapter} from "./adapters/objection-adapter";
-import {FixtureRiveter} from "./fixture-riveter";
+import {SequelizeAdapter} from "./adapters/sequelize-adapter";
+
+import {Strategy} from "./strategies/strategy";
+import {AttributesForStrategy} from "./strategies/attributes-for-strategy";
+import {BuildStrategy} from "./strategies/build-strategy";
+import {CreateStrategy} from "./strategies/create-strategy";
 
 const fr = new FixtureRiveter();
 
 export {
 	fr,
+	FixtureRiveter,
+
 	Adapter,
 	DefaultAdapter,
 	ObjectionAdapter,
+	SequelizeAdapter,
+
+	Strategy,
+	AttributesForStrategy,
+	BuildStrategy,
+	CreateStrategy,
 };