make Slipstream module the main docs page

NFIBrokerage · Feb 2, 2021 · fee6494 · fee6494
1 parent 4de27d8
commit fee6494
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,14 @@ The format is based on [Keep a
 Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.2.3 - 2021-02-02
+
+### Changed
+
+- docs: the main page now shows the `Slipstream` module
+    - frankly, I just want people to see the Basic Usage section as soon as
+      possible so they get a taste for the library
+
 ## 0.2.2 - 2021-02-01
 
 ### Fixed

diff --git a/mix.exs b/mix.exs
@@ -96,6 +96,7 @@ defmodule Slipstream.MixProject do
       deps: [],
       language: "en",
       formatters: ["html"],
+      main: Slipstream,
       extras: [
         "CHANGELOG.md",
         "guides/implementation.md"