rcurses 2.2 → 2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df1c1a4900f937e9e6b6b8ff3ca39d830d548c2e5a2627d57cdc058939b9aa02
-  data.tar.gz: 8098dc2b5bb4dca9a33a33d17dc6b91ecf496da7a18f6766990abcf036b6d7ff
+  metadata.gz: 00434da0ec522a7b5452e13379984e832e5548ac7e070326b74b9e5e19da74a1
+  data.tar.gz: c49c694b53e4521d3959e76d18117dfc6f40c9a151c28d48d00ebf2688a261ac
 SHA512:
-  metadata.gz: 9f6edc61f223b29c81c268f0141c75d0a7ea6b1a176da81dbd2fe8efadf3c9ddda6d0be90d69b170771a56b2e947c5422d720d676e6697ffc909f988e9de2123
-  data.tar.gz: a3dd0151452e7f910d2a1e2d9032a1b98c99df77d91bf7e3e9d3024391755d759625064d1d11404496f69b73d1bf08681a4286b82b058538cf45d32d80eeba44
+  metadata.gz: 3cfd5abe01873f4e5a1b52bbf47e6e9322abe30ecbb366a80ccd97599cec04b02a61c1ed589a4bf60310380e7c0b4f2cde6e64d95cedb1403698e31ae6a63e7a
+  data.tar.gz: 0e0e13e13de006efe4c42c30e793a6aae63e1d6431748fe6f3aa79e9ef96721d5dae00517fe356b85c0d473ccd1c64bb6618c62a3e9e818681c8e39ea59bf755

data/README.md

@@ -4,12 +4,13 @@
 
 <img src="img/rcurses-logo.png" width="150" height="150">
 
+Create curses applications for the terminal easier than ever.
 
 # Why?
 Having struggled with the venerable curses library and the ruby interface to it for many years, I finally got around to write an alternative - in pure Ruby.
 
 # Design principles
-Simple. One file. Minimum of external dependencies.
+Simple and with minimum of external dependencies.
 
 # Installation
 Simply run `gem install rcurses`.
@@ -104,7 +105,7 @@ pure           | Strip text of any "dressing" (example: with `text = "TEST".b`,
 PS: Blink does not work in conjunction with setting a background color in urxvt. It does work in gnome-terminal. But the overall performance in urxvt as orders of magnitude better than gnome-terminal.
 
 # module Cursor
-Create a new cursor object with `mycursor = Cursor`. Then you can apply the following methods to `mycursor`:
+To use this module, first do `include Rcurses::Cursor`. Create a new cursor object with `mycursor = Cursor`. Then you can apply the following methods to `mycursor`:
 
 Method            | Description
 ------------------|---------------------------------------------------------------
@@ -128,10 +129,12 @@ clear_line_after  | Erase from the current position (inclusive) to the end of th
 scroll_up         | Scroll display up one line
 scroll_down       | Scroll display down one line
 clear_screen_down | Clear screen down from current row
+hide_cursor       | Hide the cursor
+show_cursor       | Show cursor
 
 # The function getchr
 rcurses provides a vital extension to Ruby in reading characters entered by the user. This is especially needed for curses applications where readline inputs are required.
-The function getchr is automatically included in your arsenal when you first do `include rcurses`.
+The function getchr is automatically included in your arsenal when you first do `include Rcurses::Input`.
 
 Simply use `chr = getchr` in a program to read any character input by the user. The returning code (the content of `chr` in this example) could be any of the following:
 

data/lib/rcurses.rb

@@ -5,7 +5,7 @@
 # Web_site:   http://isene.com/
 # Github:     https://github.com/isene/rcurses
 # License:    Public domain
-# Version:    2.2: Added example focus_panes.rb and hide_cursor/show_cursor as Cursor functions
+# Version:    2.3: Updated docs.
 
 require 'io/console' # Basic gem for rcurses
 require 'io/wait'    # stdin handling

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rcurses
 version: !ruby/object:Gem::Version
-  version: '2.2'
+  version: '2.3'
 platform: ruby
 authors:
 - Geir Isene
@@ -24,12 +24,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 'Create panes (with the colors and(or border), manipulate the panes and
-  add content. Dress up text (in panes or anywhere in the terminal) in bold, italic,
-  underline, reverse color, blink and in any 256 terminal colors for foreground and
-  background. Use a simple editor to let users edit text in panes. Left, right or
-  center align text in panes. Cursor movement around the terminal. New in 2.2: Added
-  example focus_panes.rb and hide_cursor/show_cursor as Cursor functions.'
+description: 'Create curses applications for the terminal easier than ever. Create
+  panes (with the colors and(or border), manipulate the panes and add content. Dress
+  up text (in panes or anywhere in the terminal) in bold, italic, underline, reverse
+  color, blink and in any 256 terminal colors for foreground and background. Use a
+  simple editor to let users edit text in panes. Left, right or center align text
+  in panes. Cursor movement around the terminal. New in 2.3: Updated docs..'
 email: g@isene.com
 executables: []
 extensions: []