diff --git a/README.asciidoc b/README.asciidoc new file mode 100644 index 00000000..95e9eb3d --- /dev/null +++ b/README.asciidoc @@ -0,0 +1,88 @@ +:currentReleaseVersion: 1.1.0.RELEASE +:currentSnapshotVersion: 1.2.0.BUILD-SNAPSHOT + +Spring Shell is an shell skeleton that can be easily extended with commands using a Spring based programming model. Spring Shell eases the creation of interactive console applications, featuring ANSI coloring, TAB completion, history browsing, _etc._ + +To witness possibilities of Spring Shell, have a look at the http://docs.spring.io/spring-xd/docs/current-SNAPSHOT/reference/html/#interactive-shell[Spring XD Shell]. + +The latest release version is {currentReleaseVersion}, while the development version is {currentSnapshotVersion}. + +# Useful links + +* http://static.springsource.org/spring-shell/docs/current/reference/[User documentation] +* https://jira.spring.io/browse/SHL[Issue Tracker] + +# Artifacts + +[filter=source,language=xml,subs="attributes,specialcharacters"] +---- + + + + spring-release + Spring Maven RELEASE Repository + http://repo.springframework.org/release + + + + + libs-release + Spring Maven libs-release Repository + http://repo.springframework.org/libs-release + + + + org.springframework.shell + spring-shell + {currentReleaseVersion} + + + + + + spring-snapshot + Spring Maven SNAPSHOT Repository + http://repo.springframework.org/libs-snapshot + + + + org.springframework.shell + spring-shell + {currentSnapshotVersion} + +---- + + +* Gradle: + +[subs="attributes,specialcharacters"] +---- +repositories { + maven { url "http://repo.springsource.org/lib-release" } +} + +dependencies { + compile "org.springframework.shell:spring-shell:{currentReleaseVersion}" +} +---- + +# Building +Spring Shell is built with Gradle. To build Spring Shell, run + + ./gradlew + +# Running Example + + cd samples/helloworld + ./gradlew installApp + cd build/install/helloworld/bin + helloworld + + +# Contributing + +Here are some ways for you to get involved in the community: + +* Get involved with the Spring community on Stack Overflow. Please help out on the http://stackoverflow.com/questions/tagged/spring-shell[dedicated SO tag] by responding to questions and joining the debate. +* Create https://jira.spring.io/browse/SHL[JIRA] tickets for bugs and new features and comment and vote on the ones that you are interested in. +Github is for social coding: if you want to write code, we encourage contributions through pull requests from http://help.github.com/forking/[forks of this repository]. If you want to contribute code this way, please reference a JIRA tracker ticket covering the specific issue you are addressing. Before we accept a non-trivial patch or pull request we will need you to sign the https://support.springsource.com/spring_committer_signup[contributor's agreement]. Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests. diff --git a/README.md b/README.md deleted file mode 100644 index 57910d18..00000000 --- a/README.md +++ /dev/null @@ -1,80 +0,0 @@ -Spring Shell is an interactive shell that can be easily extended with commands using a Spring based programming model. The latest GA release is 1.1.0.RELEASE. - -# Useful links - -* [User documentation](http://static.springsource.org/spring-shell/docs/current/reference/) -* [Issue Tracker](https://jira.spring.io/browse/SHL) - -# Artifacts - -~~~~~ xml - - - - spring-release - Spring Maven RELEASE Repository - http://repo.springframework.org/release - - - - - libs-release - Spring Maven libs-release Repository - http://repo.springframework.org/libs-release - - - - org.springframework.shell - spring-shell - 1.1.0.RELEASE - - - - - - spring-snapshot - Spring Maven SNAPSHOT Repository - http://repo.springframework.org/libs-snapshot - - - - org.springframework.shell - spring-shell - 1.0.1.SNAPSHOT - - -~~~~~ - -* Gradle: - -~~~~~ groovy -repositories { - maven { url "http://repo.springsource.org/lib-release" } -} - -dependencies { - compile "org.springframework.shell:spring-shell:1.1.0.RELEASE" -} -~~~~~ - - -# Building -Spring Shell is built with Gradle. To build Spring Shell, run - - ./gradlew - -# Running Example - - cd samples/helloworld - ./gradlew installApp - cd build/install/helloworld/bin - helloworld - - -# Contributing - -Here are some ways for you to get involved in the community: - -* Get involved with the Spring community on Stack Overflow. Please help out on the [dedicated SO tag](http://stackoverflow.com/questions/tagged/spring-shell) by responding to questions and joining the debate. -* Create [JIRA](https://jira.spring.io/browse/SHL) tickets for bugs and new features and comment and vote on the ones that you are interested in. -Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](http://help.github.com/forking/). If you want to contribute code this way, please reference a JIRA tracker ticket covering the specific issue you are addressing. Before we accept a non-trivial patch or pull request we will need you to sign the [contributor's agreement](https://support.springsource.com/spring_committer_signup). Signing the contributor's agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team, and given the ability to merge pull requests. diff --git a/gradle.properties b/gradle.properties index f21d141f..b3f7c4ba 100644 --- a/gradle.properties +++ b/gradle.properties @@ -5,6 +5,6 @@ junitVersion=4.11 springVersion=4.0.6.RELEASE commonsioVersion=2.4 hamcrestVersion=1.3 -version=1.1.0.BUILD-SNAPSHOT +version=1.2.0.BUILD-SNAPSHOT mockitoVersion=1.9.5 hamcrestDateVersion=0.9.3 \ No newline at end of file