Skip to content

Commit

Permalink
Update README.asciidoc
Browse files Browse the repository at this point in the history
  • Loading branch information
gastaldi committed Mar 31, 2016
1 parent ebfb5e9 commit 276ce92
Showing 1 changed file with 20 additions and 25 deletions.
45 changes: 20 additions & 25 deletions README.asciidoc
Original file line number Diff line number Diff line change
@@ -1,19 +1,33 @@
Roaster
=======
Roaster - The only Java source parser library you'll ever need
===============================================================

image:https://travis-ci.org/forge/roaster.svg?branch=master["Build Status", link="https://travis-ci.org/forge/roaster"]
image:http://img.shields.io/:license-EPL-blue.svg["License", link="https://www.eclipse.org/legal/epl-v10.html"]
image:https://maven-badges.herokuapp.com/maven-central/org.jboss.forge.roaster/roaster-api/badge.svg["Maven Central", link="https://maven-badges.herokuapp.com/maven-central/org.jboss.forge.roaster/roaster-api"]

Roaster (formerly known as java-parser) is a library that allows easy parsing and formatting of java source files.
Roaster introduces a fluent interface to manipulate Java source files, like adding fields, methods, annotations and so on.

Installation
============
* Download (or build from sources) the most recent roaster-distribution-VERSION.zip.
.. Download link:https://repository.jboss.org/nexus/service/local/artifact/maven/redirect?r=releases&g=org.jboss.forge.roaster&a=roaster-distribution&v=LATEST&e=zip[Roaster (Latest)]
... This ZIP contains the Roaster distribution and command line tools

* Extract the ZIP to a directory and navigate to roaster-distribution-VERSION/bin directory
* If you are using Maven, add the following dependencies to your project:
```xml
<dependency>
<groupId>org.jboss.forge.roaster</groupId>
<artifactId>roaster-api</artifactId>
<version>${version.roaster}</version>
</dependency>
<dependency>
<groupId>org.jboss.forge.roaster</groupId>
<artifactId>roaster-jdt</artifactId>
<version>${version.roaster}</version>
<scope>runtime</scope>
</dependency>
```

* Otherwise, download and extract (or build from sources) the most recent http://search.maven.org/#search|ga|1|a%3A%22roaster-distribution%22[the most recent distribution] containing the Roaster distribution and command line tools
Usage
=====
Expand Down Expand Up @@ -188,25 +202,6 @@ JavaClassSource myClass = unit.getGoverningType();
JavaClassSource anotherClass = (JavaClassSource) unit.getTopLevelTypes().get(1);
```


Maven Artifacts
===============
Download http://search.maven.org/#search%7Cga%7C1%7Cg:%22org.jboss.forge.roaster%22[the latest .jar] or dependency via Maven:
```xml
<dependency>
<groupId>org.jboss.forge.roaster</groupId>
<artifactId>roaster-api</artifactId>
<version>${version.roaster}</version>
</dependency>
<dependency>
<groupId>org.jboss.forge.roaster</groupId>
<artifactId>roaster-jdt</artifactId>
<version>${version.roaster}</version>
</dependency>
```
Issue tracker
=============
Expand Down

0 comments on commit 276ce92

Please sign in to comment.