aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorun0btanium <unobtaniumLoL@gmail.com>2018-01-28 15:32:45 +0100
committerGitHub <noreply@github.com>2018-01-28 15:32:45 +0100
commit785f93569173bfe36fdc825cc0ed6c8745a54d96 (patch)
treed0bd8d4c3a35d21b49b96083c7b1258a33e929ee /readme.md
parent59fa7630dec7637e81cca3a3fb2bb942284abf0f (diff)
downloadjavaparser-785f93569173bfe36fdc825cc0ed6c8745a54d96.tar.gz
#1358 Updated Readme
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md26
1 files changed, 24 insertions, 2 deletions
diff --git a/readme.md b/readme.md
index dc2a26a3f..9ac7e75ec 100644
--- a/readme.md
+++ b/readme.md
@@ -15,7 +15,29 @@ The project binaries are available in Maven Central. Just add the following to
[Please refer to the Migration Guide when upgrading from 2.5.1 to 3.0.0+](https://github.com/javaparser/javaparser/wiki/Migration-Guide)
-For Maven:
+**Maven**:
+
+```xml
+<dependency>
+ <groupId>com.github.javaparser</groupId>
+ <artifactId>javaparser-symbol-solver-core</artifactId>
+ <version>3.5.11</version>
+</dependency>
+```
+
+**Gradle**:
+
+```
+compile 'com.github.javaparser:javaparser-symbol-solver-core:3.5.11'
+```
+
+
+
+Since Version 3.5.10, the JavaParser project includes the JavaSymbolSolver. While JavaParser generates an Abstract Syntax Tree, JavaSymbolSolver analyzes that AST and is able to find the relation between an element and its declaration (e.g. for a variable name it could be a parameter of a method, providing information about its type, position in the AST, ect).
+
+Using the dependency above will add both JavaParser and JavaSymbolSolver to your project. If you only need the core functionality of parsing Java source code in order to traverse and manipulate the generated AST, you can reduce your projects boilerplate by only including JavaParser to your project:
+
+**Maven**:
```xml
<dependency>
@@ -25,7 +47,7 @@ For Maven:
</dependency>
```
-For Gradle:
+**Gradle**:
```
compile 'com.github.javaparser:javaparser-core:3.5.11'