proper module and docs

README.md

@@ -1,4 +1,4 @@
 interactive-plot
 ================
 
-Simple terminal interactive plotter.
+Quick time series terminal plotting for data exploration/in ghci.

package.yaml

@@ -11,13 +11,12 @@ extra-source-files:
 - CHANGELOG.md
 
 # Metadata used when publishing your package
-synopsis:            Quick time series plotting meant to be used interactively in ghci
+synopsis:            Interactive quick time series plotting
 category:            Interactive
 
-# To avoid duplicated efforts in documentation and dealing with the
-# complications of embedding Haddock markup inside cabal files, it is
-# common to point users to the README.md file.
-description:         Please see the README on GitHub at <https://github.com/mstksg/interactive-plot#readme>
+description: |
+  Quick time series terminal plotting for data exploration/in ghci. See
+  documentation for "Interactive.Plot".
 
 dependencies:
 - base >= 4.7 && < 5

src/Interactive/Plot.hs

@@ -1,3 +1,4 @@
+{-# LANGUAGE PatternSynonyms #-}
 
 -- |
 -- Module      : Interative.Plot
@@ -11,9 +12,33 @@
 -- Simple interactive rendering of plots
 --
 module Interactive.Plot (
-    module P
+  -- * Run a Plot
+    runPlot
+  , runPlotAuto
+  , animatePlot
+  -- ** Options
+  , PlotOpts(..), poTermRatio, poAspectRatio, poXRange, poYRange, poRange, poAutoMethod, poHelp, poFramerate, poDelay
+  , defaultPlotOpts
+  -- * Construct Series
+  , Auto(..)
+  , Series, AutoSeries, SeriesF(..), sItems, sStyle
+  -- ** Making common serieses
+  , listSeries
+  , tupleSeries
+  , funcSeries
+  , enumRange
+  , toCoordMap
+  , fromCoordMap
+  -- ** Series from AutoSeroes
+  , fromAutoSeries
+  , fromAutoSeriesIO
+  , fromAutoSeries_
+  -- ** Types
+  , PointStyle, pattern PointStyle, _psMarker, _psColor, AutoPointStyle, PointStyleF(..), psMarker, psColor
+  , Coord(..), cX, cY
+  , Range(..), _rMid, _rSize', rMin, rMax, rSize, rMid, _rSize
   ) where
 
-import           Interactive.Plot.Core   as P
-import           Interactive.Plot.Run    as P
-import           Interactive.Plot.Series as P
+import           Interactive.Plot.Core
+import           Interactive.Plot.Run
+import           Interactive.Plot.Series

src/Interactive/Plot/Run.hs

@@ -111,6 +111,8 @@ pdSerieses :: Lens' PlotData [Series]
 pdSerieses f (PlotData x y z) = PlotData x y <$> f z
 
 -- | Display fixed plot and title interactively, filling in default values.
+--
+-- See 'runPlotDynamic' for more control.
 runPlotAuto
     :: PlotOpts
     -> Maybe String     -- ^ title
@@ -122,6 +124,8 @@ runPlotAuto po t d s = case po ^. poAutoMethod of
     Just g  -> runPlot po t d $ fromAutoSeries_ g s
 
 -- | Display fixed plot and title interactively.
+--
+-- See 'runPlotDynamic' for more control.
 runPlot
     :: PlotOpts
     -> Maybe String     -- ^ title

src/Interactive/Plot/Series.hs

@@ -11,16 +11,16 @@
 --
 -- Create common serieses.
 module Interactive.Plot.Series (
-    defaultStyles
   -- * Create a 'Series' from an 'AutoSeries'.
-  , fromAutoSeries
+    fromAutoSeries
   , fromAutoSeriesIO
   , fromAutoSeries_
   -- * Create common 'Series'
   , listSeries
   , tupleSeries
   , funcSeries
   , enumRange
+  , defaultStyles
   ) where
 
 import           Control.Monad.Random