Skip to content

Commit

Permalink
update doc for MavenCentral
Browse files Browse the repository at this point in the history
  • Loading branch information
pigne committed Sep 15, 2020
1 parent 978ab0d commit 18d5f00
Showing 1 changed file with 22 additions and 7 deletions.
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,21 @@ Check out the Website <http://www.graphstream-project.org/> for more information

The release comes with a pre-packaged jar file named gs-core.jar that contains the GraphStream classes. To start using GraphStream, simply put it in your class path. You can download GraphStream on the [github releases pages](https://github.com/graphstream/gs-core/releases), or on the website <http://www.graphstream-project.org/>.

Maven users, you may include gs-core as a dependency to your project using (https://jitpack.io).
Simply add the `jitpack` repository to the `pom.xml`:
Maven users may include major releases of `gs-core` as a dependency:

```xml
<dependencies>
<dependency>
<groupId>org.graphstream</groupId>
<artifactId>gs-core</artifactId>
<version>2.0</version>
</dependency>
</dependencies>
```

### Development Versions

Using <https://jitpack.io> one can also use any development version. Simply add the `jitpack` repository to the `pom.xml` of the project:

```xml
<repositories>
Expand All @@ -27,11 +40,13 @@ Simply add the `jitpack` repository to the `pom.xml`:
then, add the `gs-core` to your dependencies:

```xml
<dependency>
<groupId>com.github.graphstream</groupId>
<artifactId>gs-core</artifactId>
<version>2.0</version>
</dependency>
<dependencies>
<dependency>
<groupId>com.github.graphstream</groupId>
<artifactId>gs-core</artifactId>
<version>dev-SNAPSHOT</version>
</dependency>
</dependencies>
```

You can use any version of `gs-core` you need. Simply specify the desired version in the `<version>` tag. The version can be a git tag name (e.g. `2.0`), a commit number, or a branch name followed by `-SNAPSHOT` (e.g. `dev-SNAPSHOT`). More details on the [possible versions on jitpack](https://jitpack.io/#graphstream/gs-core).
Expand Down

0 comments on commit 18d5f00

Please sign in to comment.