diff --git a/README.md b/README.md index d9a76f94e..12cf29aed 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,7 @@ http://www.opensource.org/licenses/bsd-license.php --> -Description ------------ +# Description JLine is a Java library for handling console input. It is similar in functionality to [BSD editline](http://www.thrysoee.dk/editline/) and [GNU readline](http://www.gnu.org/s/readline/) but with additional features that bring it in par with [ZSH line editor](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html). People familiar with the readline/editline capabilities for modern shells (such as bash and tcsh) will find most of the command editing features of JLine to be familiar. @@ -17,25 +16,21 @@ JLine 3.x is an evolution of [JLine 2.x](https://github.com/jline/jline2). [![Build Status](https://travis-ci.org/jline/jline3.svg?branch=master)](https://travis-ci.org/jline/jline3) -License -------- +# License JLine is distributed under the [BSD License](http://www.opensource.org/licenses/bsd-license.php), meaning that you are completely free to redistribute, modify, or sell it with almost no restrictions. -Documentation -------------- +# Documentation * [demos](https://github.com/jline/jline3/wiki/Demos) * [wiki](https://github.com/jline/jline3/wiki) -Forums ------- +# Forums * [jline-users](https://groups.google.com/group/jline-users) * [jline-dev](https://groups.google.com/group/jline-dev) -Maven Usage ------------ +# Maven Usage Use the following definition to use JLine in your maven project: @@ -58,12 +53,11 @@ JLine can also be used with more low-level jars: 3.2.0 -Building --------- +# Building -### Requirements +## Requirements -* Maven 3.3+ +* Maven 3.3+ (prefer included maven-wrapper) * Java 8+ Check out and build: