Commits

Steve Losh committed 17feee9

Bump version, fix arglist, document new stuff.

Comments (0)

Files changed (6)

 32f723f354b1cdbc3d694aee2c0be0616ceeb864 v0.9.1
 fd5f2169c59b411ee114db987e333bfd94a6de05 v0.9.2
+08bc6fb4338be2709e71cd021f4399ad441a67ee v0.9.3

docs/1-installation.markdown

 
 Add this to your `project.clj`:
 
-    [clojure-lanterna "0.9.2"]
+    [clojure-lanterna "0.9.3"]
 
 That's it.

docs/4-reference.markdown

 
     :::clojure
     (get-key-blocking terminal)
+    (get-key-blocking terminal options)
 
 Get the next keypress from the user.
 
 If you want to return immediately instead of blocking when no input is buffered,
 use [`get-key`](#lanternaterminalget-key) instead.
 
+The `options` map can contain any of the following mappings:
+
+* `:interval` - The interval between checks, in milliseconds (default `50`).
+* `:timeout` - The maximum amount of time blocking will occur before returning
+  `nil` (default infinity).
+
 ### lanterna.terminal/add-resize-listener
 
     :::clojure
 when you call [`get-terminal`](#lanternaterminalget-terminal).  It's here if you
 *do* need it though.
 
+### lanterna.terminal/remove-resize-listener
+
+    :::clojure
+    (remove-resize-listener terminal listener)
+
+Remove the given resize listener from the given terminal.
+
 ### lanterna.terminal/get-available-fonts
 
     :::clojure
 If you want to return immediately instead of blocking when no input is buffered,
 use [`get-key`](#lanternascreenget-key) instead.
 
+The `options` map can contain any of the following mappings:
+
+* `:interval` - The interval between checks, in milliseconds (default `50`).
+* `:timeout` - The maximum amount of time blocking will occur before returning
+  `nil` (default infinity).
+
 ### lanterna.screen/add-resize-listener
 
     :::clojure
 when you call [`get-screen`](#lanternascreenget-screen).  It's here if you *do*
 need it though.
 
+### lanterna.screen/remove-resize-listener
+
+    :::clojure
+    (remove-resize-listener screen listener)
+
+Remove the given resize listener from the given screen.

docs/5-changelog.markdown

 
 Here's the list of changes in each released version.
 
+v0.9.3
+------
+* `get-key-blocking` now accepts optional arguments for timeout and interval.
+* Added `remove-resize-listener` functions for Screens and Terminals.
 
 v0.9.2
 ------
-(defproject clojure-lanterna "0.9.2"
+(defproject clojure-lanterna "0.9.3"
   :description "A Clojure wrapper around the Lanterna terminal output library."
   :url "http://sjl.bitbucket.org/clojure-lanterna/"
   :license {:name "LGPL"}

src/lanterna/screen.clj

 
   "
   ([^Screen screen] (get-key-blocking screen {}))
-  ([^Screen screen & {:keys [interval timeout] :as opts}]
+  ([^Screen screen {:keys [interval timeout] :as opts}]
      (block-on get-key [screen] opts)))