Update docs + bump version to 0.1.1 (#24)

Author: c42f

Project.toml

@@ -1,7 +1,7 @@
 name = "TerminalLoggers"
 uuid = "5d786b92-1e48-4d6f-9151-6b4477ca9bed"
 authors = ["Chris Foster <[email protected]>"]
-version = "0.1.0"
+version = "0.1.1"
 
 [deps]
 LeftChildRightSiblingTrees = "1d6d02ad-be62-4b6b-8a6d-2f90e265016e"

docs/src/index.md

@@ -27,21 +27,45 @@ atreplinit() do repl
 end
 ```
 
+## Markdown
+
+`TerminalLogger` interprets all `AbstractString` log messages as markdown so
+you can use markdown formatting to display readable formatted messages. For
+example,
+
+```
+@info """
+    # A heading
+
+    About to do the following
+
+    * A list
+    * Of actions
+    * To take
+    """
+```
 
 ## Progress bars
 
 `TerminalLogger` displays progress logging as a set of progress bars which are
 cleanly separated from the rest of the program output at the bottom of the
-terminal. Try an example like the following
+terminal.
+
+For robust progress logging, `TerminalLoggers` recognizes the `Progress` type
+from the [`ProgressLogging` package](https://junolab.org/ProgressLogging.jl/stable/).
+For easy to use progress reporting you can therefore use the `@progress` macro:
 
 ```julia
 global_logger(TerminalLogger(right_justify=120))
-for i=1:100
+using ProgressLogging
+
+@progress for i=1:100
     if i == 50
-        @warn "Middle of computation" i
+        @info "Middle of computation" i
+    elseif i == 70
+        println("Normal output does not interfere with progress bars")
     end
     sleep(0.01)
-    @info "Some progress" progress=i/100
 end
 @info "Done"
 ```
@@ -52,6 +76,9 @@ end
     We expect this will eventually be solved with some combination of libuv
     updates and the new windows terminal.
 
+You can also use the older progress logging API with the `progress=fraction`
+key value pair. This is simpler but has some downsides such as not interacting
+correctly with exceptions.
 
 ## API Reference