Files
jsqrl/README.md
2024-08-28 09:07:56 -04:00

31 lines
1.1 KiB
Markdown

# Jsqrl
![GitHub last commit](https://img.shields.io/github/last-commit/JHUAPL/jsqrl)
Jsqrl (pronounced "Jay Squirrel") is a general use, low level Java library for saving/restoring the state of Java objects to/from JSON format files.
## Usage
Jsqrl directly supports saving and restoring Java primitive types, arrays, containers, and maps. There is a registry system to enable saving and restoring objects of arbitrary type. It can also save and restore the state of stateful (mutable) objects.
Jsqrl is available as a jar at [Maven Central](https://central.sonatype.com/artifact/edu.jhuapl.ses/jsqrl). The dependency listing is:
```
<dependency>
<groupId>edu.jhuapl.ses</groupId>
<artifactId>jsqrl</artifactId>
<version>1.0.1</version>
</dependency>
```
## Contributing
Please see the [Contributing](Contributing.md) file for information. Pull requests will be reviewed and merged on a best-effort basis; there are no guarantees, due to funding restrictions.
## Code of Conduct
The Jsqrl package ascribes to the [Github Code of Conduct](https://docs.github.com/en/site-policy/github-terms/github-community-code-of-conduct).