Skip to content

Commit 9f49c61

Browse files
Update README.md
quick links
1 parent 4e0a22b commit 9f49c61

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

+23-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,27 @@
11
# Java-SerialX
2+
## Quick links
3+
* If you want to download/import the library, add this to your pom.xml. Or take a look at [Packages](https://github.com/SimplyProgrammer?tab=packages&repo_name=Java-SerialX).
4+
```
5+
<dependencies>
6+
<dependency>
7+
<groupId>org.ugp.serialx</groupId>
8+
<artifactId>serialx-json</artifactId>
9+
<version>1.3.8</version> <!-- Specify newer version if needed -->
10+
</dependency>
11+
</dependencies>
12+
13+
<repositories>
14+
<repository>
15+
<id>github</id>
16+
<url>https://maven.pkg.github.com/SimplyProgrammer/Java-SerialX</url>
17+
</repository>
18+
</repositories>
19+
```
20+
* If you want to add or see issues just click on [Issues section](https://github.com/PetoPetko/Java-SerialX/issues) in up.
21+
* If you want to comment or suggest a feature use [Discussions section](https://github.com/PetoPetko/Java-SerialX/discussions).
22+
* If you want to see or learn some things about library, take a look at [examples](https://github.com/SimplyProgrammer/Java-SerialX/tree/tests-and-experimental-features/src/examples).
23+
* And if you want to see the changelog open [changelog file](Changelog.md) or use [Releases section](https://github.com/PetoPetko/Java-SerialX/releases) too.
24+
<br>
225
SerialX is powerful and lightweighted utility library to serialize objects in Java. Serialization means storing Java objects and values into some media (for example text file).<br>
326
SerialX is improving regular Java Base64 serialization and adding serialization protocols that you can create for objects that cant be serialized using regular way. For example final non-serializable objects, 3rd party objects and others. SerialX API is storing objects into JSON like "programming" language (data format) called JUSS (Java universal serial script) which shares common functionality with JSON and provides more customizability and extended functionality! This allows you to serialize multiple objects into one string or also into file. But unlike to JSON, JUSS general conception is based on determinate order of arguments or values we can say. The latest versions also provides variable system (keys, values) similar to JSON. But in JUSS these variables can be overided and can interact with each other and can be used multiple times. Nowadays SerialX provides recursive descent parser that can be modified so you can create your own data structures! In other words SerialX allows you to serialize **anything**, it's pretty simple to use and practically limitless!
427
## Brief overview of working concept and advantages compared to regular serialization:
@@ -127,9 +150,3 @@ some.package.Foo {
127150
And value's data type is specified by suffix if it is a primitive data type or simply by package name as the first argument in case of an object! Other arguments (count, order, type) are then specified by a SerializationProtocol! Generally, one line means one object, one value (separated by spaces) means one argument! <br><br>
128151
Note: Since there is variable system in 1.1.5, the order of values is now not the only option to obtain an object or value! <br>
129152
<br>
130-
## Info
131-
* If you want to add or see issues just click on [Issues section](https://github.com/PetoPetko/Java-SerialX/issues) in up.
132-
* If you want to comment or suggest a feature use [Discussions section](https://github.com/PetoPetko/Java-SerialX/discussions).
133-
* If you want to see or learn some things about library, take a look at [examples](https://github.com/SimplyProgrammer/Java-SerialX/tree/tests-and-experimental-features/src/examples).
134-
* If you want to download the library, dont use commits section, use [Releases section](https://github.com/PetoPetko/Java-SerialX/releases) or click that big green button "Clone or download" to download the latest version.
135-
* And if you want to see the changelog open [changelog file](Changelog.md) or use [Releases section](https://github.com/PetoPetko/Java-SerialX/releases) too.

0 commit comments

Comments
 (0)