terminal-scroll-area 0.0.1 → 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +21 -0
  3. data/README.md +16 -0
  4. metadata +6 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 40c9d9bbc20a2507effd83bcb58b1079d900fc44a7d06ca84353ff1d9aa197b2
4
- data.tar.gz: 7d86e009629484903f837f0546d93dea58ad0b7753aeff9fa03012a89f7e83a9
3
+ metadata.gz: ecf85071f9ed12d1f05f102fd3dba17dbc5519f8a98bcb18f509b1c3585033f0
4
+ data.tar.gz: a1a47375eb3075acbd2da06c92e2efbcd4d954c719271c6d6fc06c1dc88ebde1
5
5
  SHA512:
6
- metadata.gz: c23164544666966a7b5ba12aca35fe911de61a084df75bb1ea620d1d8d93aab8314293c633e3725af939dfe00084b575ded9d676e71d37f2ab1bee77e0ec4488
7
- data.tar.gz: 59cfee4ad6c585515b44e897f8047e5fd282112c950c040f9db283b02bb21feca9e85ec78a63f9aab6d12f5e5d66227ca65fd0b0b1a222b8d49284b26dc60361
6
+ metadata.gz: 9a8162ae1e89cd1d30ab40c15d58b076c289e08d1ac51b2293998f411bb7627219e791c4b8745b8aea7fa7c9946df2926f01e042eb68cf52435c6ae9f4f04eed
7
+ data.tar.gz: 7483e935777825266318b6007e161ab1a38a872c95560cf2ccf6711c9078752844bffec231219247cd10ce9448ca51ea5ec266a333a19825a9b0f8cc9d4103b6
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2020 ilkutkutlar
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md CHANGED
@@ -1,9 +1,25 @@
1
1
  # Terminal Scroll Area
2
2
 
3
+ [![Gem Version](https://badge.fury.io/rb/terminal-scroll-area.svg)](https://badge.fury.io/rb/terminal-scroll-area)
4
+
5
+ <img alt="Gif showing usage" src="https://raw.githubusercontent.com/ilkutkutlar/terminal-scroll-area/main/usage.gif" width=50%>
6
+
3
7
  This gem lets the user display large text on terminal by creating a scroll area in which only a specified portion of the text is displayed at a time. This portion can be moved to reveal other parts of the text, analogous to a GUI scroll area, or a more general purpose pager. This gem is useful when your program needs to display a large amount of text that may not fit into the screen.
4
8
 
5
9
  The `ScrollArea` class, which is not interactive, does not use Curses or a similar screen management library. The `InteractiveScrollArea` class does not rely on the Curses library and instead uses the [TTY toolkit](https://github.com/piotrmurach/tty), which has cross platform support and support for many types of terminals/terminal emulators. Therefore this gem should also have the same level of support.
6
10
 
11
+ # Installation
12
+
13
+ ```rb
14
+ gem install 'terminal-scroll-area'
15
+ ```
16
+
17
+ or add it to your project's `Gemfile`:
18
+
19
+ ```rb
20
+ gem 'terminal-scroll-area'
21
+ ```
22
+
7
23
  # Usage
8
24
 
9
25
  ## `ScrollArea` class
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: terminal-scroll-area
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ilkut Kutlar
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-06-07 00:00:00.000000000 Z
11
+ date: 2020-08-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tty-cursor
@@ -88,8 +88,11 @@ email:
88
88
  - ilkutkutlar@gmail.com
89
89
  executables: []
90
90
  extensions: []
91
- extra_rdoc_files: []
91
+ extra_rdoc_files:
92
+ - README.md
93
+ - LICENSE
92
94
  files:
95
+ - LICENSE
93
96
  - README.md
94
97
  - lib/terminal-scroll-area.rb
95
98
  - lib/terminal-scroll-area/interactive_scroll_area.rb