Merge branch 'release/0.3.0'

Author: olivertwistor

.gitignore

@@ -1,5 +1,3 @@
 .idea/
-build/
-dist/
-docs/
+target/
 *.iml

CHANGELOG.md

@@ -1,15 +1,22 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog][1] and this project adheres to 
-[Semantic Versioning 2.0.0][2].
+The format is based on [Keep a Changelog][1] and this project adheres to [Semantic Versioning 2.0.0][2].
+
+## [0.3.0][4] (2022-06-08)
+
+* Added
+  * A Maven POM to make it easier to add this project as a dependency.
+  * Method for reading boolean input.
 
 ## [0.1.0][3] (2019-09-11)
-### Added
-* The class `Terminal` with static methods for writing to and reading from 
-standard input and output.
+
+* Added
+  * The class `Terminal` with static methods for writing to and reading from standard input and output.
 
 
 [1]: https://keepachangelog.com/en/1.0.0/
 [2]: https://semver.org/
 [3]: https://github.com/olivertwistor/java-tui/releases/tag/v0.1.0
+[4]: https://github.com/olivertwistor/java-tui/releases/tag/v0.3.0

CONTRIBUTING.md

@@ -1,76 +1,36 @@
-# How to contribute to this project
-I'm happy that you are interested in contributing to this project. The open 
-source community depends on people like you, and together we can make this 
-project as good as it can possibly be. Thank you!
+# Contributing to this project
 
-This document describes, first of all, code of conduct (a very important read), 
-then some ideas of with what you may contribute and, last but not least, 
-explanations on what you must do to start working on an issue and get your work 
-merged into this project.
-
-## Table of contents
-* [Code of conduct](#code-of-conduct)
-* [Contribution ideas](#contribution-ideas)
-* [How to make changes to the project][4]
+I'm happy you're interested in contributing to this project. The open source community depends on people like you, and together we can make this project as good as it can possibly be. Thank you!
 
 ## Code of conduct
-The open source community should be open and welcoming for all. I have a zero 
-tolerance policy against discrimination of race, ethnicity, religious 
-affiliation, sexual orientation, gender identity, age, disability etc.
 
-I urge everyone to be respectful to each other and remember that behind that 
-username is a human being. If someone makes a mistake or makes a "stupid" 
-comment or question, please bear in mind that they may be a beginner, something 
-everyone has once been.
+The open source community should be open and welcoming for all. I have a zero tolerance policy against discrimination of race, ethnicity, religious affiliation, sexual orientation, gender identity, age, disability etc.
+
+I urge everyone to be respectful to each other and remember that behind that username is a human being. If someone makes a mistake or makes a "stupid" comment or question, please bear in mind that they may be a beginner, something everyone has once been.
 
-Feel free to e-mail me at [oliver_twistor@hotmail.com][1] if you have any 
-questions or complaints regarding this or anything else.
+Feel free to contact me through my [GitHub page][1] if you have any questions or complaints regarding this or anything else.
 
 ## Contribution ideas
-There are many ways in which you can contribute to this project. Some of them 
-are listed in the following subsections.
 
-### Start working on an open issue
-One very practical way in which you can contribute is to take a look at the 
-[list of open and unassigned issues][3] to see if there is anything you want to 
-help out with. For information on the necessary steps for that, please read the 
-section *[How to make changes to the project][4]*.
+There are many ways in which you can contribute to this project. Some of them are listed here.
 
 ### Report bugs, propose new features or changes in existing features
-All software has bugs and I would very much appreciate help with identifying and 
-reporting bugs, so they can be fixed. This is a good way to contribute even if 
-you aren't a programmer.
 
-When you have used this application for a while, you may come up with some 
-ideas of cool new features, or annoyances in existing features which you would 
-want to have changed. I very much appreciate new ideas on how to improve this 
-application.
+All software has bugs, and I would very much appreciate help with identifying and reporting bugs, so they can be fixed. This is a good way to contribute even if you aren't a programmer yourself.
 
 #### How to create a new issue
 
 1. Go to the [new issue][2] page.
 1. Write a short and succinct *title*.
 1. Provide more details in the *comment* field if the title isn't enough.
-1. If you don't have repository access, skip to the next step.
-    1. Select an *assignee* that should handle the issue. If you're not 
-    selecting yourself, you should probably leave this blank.
-    1. Choose *labels*, for example *bug* for bugs and *enhancement* for new or 
-    changed features.
-    1. Leave *Project* blank since that is best determined at a later date, 
-    unless you're sure that the issue really should be part of the upcoming 
-    release. 
-    1. Leave also *Milestone* blank for the same reason as for *Project*.
+1. Leave everything else as it is.
 1. Press the button *Submit new issue*.
 
 ## How to make changes to the project
-I've found an excellent article on how to fork a repository, work on an issue 
-and then do a pull request to have your changes merged into the target 
-repository.
 
-https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/
+[GitHub help][3] is a very good resource on how to fork repositories, collaborate on issues and other things. If you need more help or want to discuss something else, please go to my [GitHub page][1] and contact me through there.
 
 
-[1]: mailto:oliver_twistor@hotmail.com
+[1]: https://github.com/olivertwistor
 [2]: https://github.com/olivertwistor/java-tui/issues/new
-[3]: https://github.com/olivertwistor/java-tui/issues
-[4]: #how-to-make-changes-to-the-project
+[3]: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Johan Nilsson
+Copyright (c) 2019-2022 Johan Nilsson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,66 +1,45 @@
 # Java TUI
-This library provides the user with easier writing to and reading from the 
-terminal.
 
-## Table of contents
-* [Who is this for?](#who-is-this-for)
-* [Prerequisites][1]
-* [Installation instructions](#installation-instructions)
-* [Usage](#usage)
-* [Licensing](#licensing)
-* [How to contribute](#how-to-contribute)
-* [Versioning](#versioning)
+Java is a verbose language. When you want to deal with user interfaces, there is a lot of boilerplate code you have to write. This library means to alleviate a lot of the boilerplate code necessary when you want to have a textual user interface.
 
-## Who is this for?
-This library may be useful for those who work with text-based user interfaces.
+## Installation
 
-## Prerequisites
-* [Java 7 or newer][2]
-
-## Installation instructions
-This is a library, not a stand-alone application. Therefore it's intended to 
-be included within other applications or libraries. 
+This is a library, not a stand-alone application. Include this in your own applications or libraries. 
 
 To make use of this library, please do the following:
-1. Make sure you meet the [prerequisites][1]. 
-1. Go to the [releases page][4] and find the specific version you want. The 
-lastest release is [0.1.0][5].
-1. Download `java-tui-x.x.x.jar` and place it in your own application's 
-classpath.
+
+1. Make sure you meet the prerequisites:
+    * [Java 7 or later][2] 
+1. Go to the [releases page][4] and find the specific version you want.
+1. Download `java-tui-x.x.x.jar` and place it in your own application's classpath.
 1. If you want Javadoc, download `java-tui-x.x.x-javadoc.jar`.
-    * Please refer to your particular IDE on how to attach that to the previous 
-    JAR file you downloaded.
-    * If you're not using an IDE, you can unpack the JAR file and browse the 
-    Javadoc in a web browser.
+    * Please refer to your particular IDE on how to attach that to the previous JAR file you downloaded.
+    * If you're not using an IDE, you can unpack the JAR file and browse the Javadoc in a web browser.
 
-### Build from source
 To build this library from source, please do the following:
-1. Make sure you meet the [prerequisites][1]. 
-1. Go to the [releases page][4] and find the specific version you want. The 
-lastest release is [0.1.0][5].
+
+1. Make sure you meet the prerequisites:
+    * [Java 7 or later][2]
+1. Go to the [releases page][4] and find the specific version you want.
 1. Download `java-tui-x.x.x-sources.jar` and unpack it.
-1. In that package, along with the source files you'll find the files 
-`build.xml` and `build.properties`. With those, you can build the library 
-(using [Apache ANT][6] or similar tools).
+1. In that package, along with the source files you'll find the files `build.xml` and `build.properties`. With those, you can build the library (using [Apache ANT][6] or similar tools).
 
 ## Usage
-In this library, there is one usable class: 
-`nu.olivertwistor.java.tui.Terminal`. With this class, the user can write to 
-and read from standard input and output.
 
-Here are some examples:
+In this library, there are two classes: `Terminal` and `UnclosableInputStream`. With `Terminal`, you can write to standard output and read from standard input. An example:
 
 ```java
 import nu.olivertwistor.java.tui.Terminal;
 
+@SuppressWarnings("ALL")
 class App
 {
     public static void main(final String[] args) throws Exception
     {
         Terminal.writeLine("Welcome to this app!");
         Terminal.write("This is the beginning of one line. ");
         Terminal.writeLine("This is continuing on that line.");
-        
+
         final int age = Terminal.readInt("Please state your age: ");
         Terminal.write("Your age is ");
         Terminal.writeLine(age);
@@ -77,27 +56,42 @@ Please state your age: 36
 Your age is 36
 ```
 
-## Licensing
-This library is licensed under the MIT License. You'll find the full license 
-terms in the file [LICENSE][3].
+The other class, `UnclosableInputStream` provides an InputStream that doesn't automatically close itself after use. An example:
+
+```java
+import java.io.BufferedReader;
+import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
+
+import nu.olivertwistor.java.tui.UnclosableInputStream;
 
-## How to contribute
-Thank you for wanting to contribute to this project. Open source is all about 
-community. Go and read the document [CONTRIBUTING.md][12] for more information 
-on with what you can contribute and how to go about it.
+@SuppressWarnings("ALL")
+class App
+{
+    public static void main(final String[] args) throws Exception
+    {
+        // Change the system input stream to prevent it closing.
+        System.setIn(new UnclosableInputStream(System.in));
+
+        try (final BufferedReader br = new BufferedReader(
+                new InputStreamReader(System.in, StandardCharsets.UTF_8)))
+        {
+            System.out.println(br.readLine());
+        }
+        finally
+        {
+            // Reset the system input stream.
+            System.setIn(System.in);
+        }
+    }
+}
+```
 
-## Versioning
-This project uses [Semantic Versioning 2.0.0][13] for version numbering. To see 
-what's changed between versions, please read [CHANGELOG.md][14]. That file also 
-has links to the download section of each release.
+## Licensing
+This library is licensed under an *MIT License*. You'll find the full license terms in the file [LICENSE][3].
 
 
-[1]: #prerequisites
 [2]: https://java.com/download/
 [3]: LICENSE
 [4]: https://github.com/olivertwistor/java-tui/releases
-[5]: https://github.com/olivertwistor/java-tui/releases/tag/v0.1.0
 [6]: https://ant.apache.org/
-[12]: CONTRIBUTING.md
-[13]: http://semver.org/
-[14]: CHANGELOG.md