Skip to content

Commit

Permalink
final readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mstksg committed Sep 9, 2019
1 parent 47be299 commit cdda40b
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
interactive-plot
================
[interactive-plot][]
====================

[interactive-plot]: https://hackage.haskell.org/package/interactive-plot

Quick time series terminal plotting for data exploration/in ghci.

Expand Down Expand Up @@ -44,7 +46,8 @@ animatePlot
animatePlotFunc
:: PlotOpts
-> Maybe String -- ^ title
-> (Double -> Maybe [Series]) -- ^ function from time to plot. will quit as soon as 'Nothing' is returned.
-> (Double -> Maybe [Series]) -- ^ function from time to plot. will quit
-- as soon as 'Nothing' is returned.
-> IO ()
```

Expand All @@ -55,3 +58,4 @@ Todo

* Consider being able to use functions directly as a series, instead of
converting them into ordered pairs based on a known x series.
* I'm sure usability could always be improved :)

0 comments on commit cdda40b

Please sign in to comment.