Skip to content

Commit 2a32b07

Browse files
committed
Bump version to 1.0.0 for deployment and set maven central coordinates in the readme file
1 parent d84d30e commit 2a32b07

File tree

3 files changed

+24
-10
lines changed

3 files changed

+24
-10
lines changed

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,25 @@ Vertices and edges can be styled through a *css stylesheet* or programmatically
1111

1212
### Prerequisites
1313

14-
You need a working JDK with JavaFX libraries to compile/use the library. The code was tested with JDK 8 and OpenJDK 11.
14+
You need a working JDK with JavaFX libraries to use/compile the library. The code was tested with JDK 8, OpenJDK 11 and LibericaJDK 19.
1515

1616
### Using the library
1717

18-
Check the `releases` folder for compiled library and source code. The **jar** library is the only requirement, but if you need to attach the *javadoc* and *source code* in your IDE, additionally use the **zip** file.
18+
> The visualization library can be used together with any ADT that adheres to the `Graph<V,E>` or `Digraph<V,E>` interfaces. Sample implementations are included, but you can devise your own.
1919
20-
The visualization library can be used together with any ADT that adheres to the `Graph<V,E>` or `Digraph<V,E>` interfaces. Sample implementations are included.
20+
You can find in the [releases section](https://github.com/brunomnsilva/JavaFXSmartGraph/releases) the binaries, source code and documentation.
21+
22+
The library is available through Maven Central. The coordinates are:
23+
24+
```xml
25+
<dependency>
26+
<groupId>com.brunomnsilva</groupId>
27+
<artifactId>smartgraph</artifactId>
28+
<version>1.0.0</version>
29+
</dependency>
30+
```
31+
32+
You should be able to use the artifact with Maven and Gradle projects with little effort.
2133

2234
### Accelerated graphics
2335

@@ -29,9 +41,11 @@ In windows the JVM machine should automatically take care of that, while in Linu
2941

3042
### What's **new**?
3143

44+
- (1.0.0) Package now available through [Maven Central](https://central.sonatype.com/?smo=true). The library seems stable, after dozens of college projects of my students have used it. Hence, the version was bumped to 1.0.0.
45+
3246
- (0.9.4) You can now annotate a method with `@SmartLabelSource` within a model class to provide the displayed label for a vertex/edge; see the example at `com.brunomnsilva.smartgraph.example`. If no annotation is present, then the `toString()` method is used to obtain the label's text.
3347

34-
- (0.9.4) You can mannualy alter a vertex position on the panel at anytime, through `SmartGraphPanel.setVertexPosition(Vertex<V> v)`; see the example at `com.brunomnsilva.smartgraph.example`.
48+
- (0.9.4) You can manually alter a vertex position on the panel at anytime, through `SmartGraphPanel.setVertexPosition(Vertex<V> v)`; see the example at `com.brunomnsilva.smartgraph.example`.
3549

3650
- (0.9.4) You can override specific default properties by using a *String* parameter to the `SmartGraphProperties` constructor; see the example at `com.brunomnsilva.smartgraph.example`. This is useful if you want to display visually different graphs within the same application.
3751

@@ -53,7 +67,7 @@ stage.setTitle("JavaFXGraph Visualization");
5367
stage.setScene(scene);
5468
stage.show();
5569

56-
//IMPORTANT - Called after scene is displayed so we can have width and height values
70+
//IMPORTANT - Called after scene is displayed, so we can have width and height values
5771
graphView.init();
5872

5973
```
@@ -91,7 +105,7 @@ graphView.setEdgeDoubleClickAction(graphEdge -> {
91105
});
92106
```
93107

94-
These actions will be performed whenever you *double click* a vertex and/or an edge.
108+
These actions will be performed whenever you *double-click* a vertex and/or an edge.
95109

96110
### Updating the view
97111

@@ -101,7 +115,7 @@ When you make changes to the graph, you can update the visualization by calling
101115
graphView.update();
102116
```
103117

104-
this will add/remove the corresponding vertices and edges from the visualization. If a new vertex is connected to an existing one, it will be initially placed in the vicinity of the later. Otherwise, if it is an *isolated* vertex it will be placed in the center of the plot.
118+
this will add/remove the corresponding vertices and edges from the visualization. If a new vertex is connected to an existing one, it will be initially placed in the vicinity of the latter. Otherwise, if it is an *isolated* vertex it will be placed in the center of the plot.
105119

106120
### SmartGraph Properties
107121

@@ -277,7 +291,7 @@ g.insertEdge("A", "A", "Loop");
277291

278292
Please note that we use the property values `edge.arrow = true` and `vertex.label = true`.
279293

280-
Given its a small graph, we increased the `layout.repulsive-force = 25000`. You should use higher values for smaller graphs; inversely, use smaller values for larger graphs.
294+
Given it's a small graph, we increased the `layout.repulsive-force = 25000`. You should use higher values for smaller graphs; inversely, use smaller values for larger graphs.
281295

282296
#### Sample Digraph circular sorted placement (static)
283297

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<groupId>com.brunomnsilva</groupId>
88
<artifactId>smartgraph</artifactId>
9-
<version>0.9.4-SNAPSHOT</version>
9+
<version>1.0.0</version>
1010
<packaging>jar</packaging>
1111

1212
<name>${project.groupId}:${project.artifactId}</name>

version.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@
2222
# THE SOFTWARE.
2323
#
2424

25-
project.version=0.9.4
25+
project.version=1.0.0

0 commit comments

Comments
 (0)