Skip to content

Commit c1e380e

Browse files
committed
Update README.md, fix pom.xml for deployment
1 parent 38f953a commit c1e380e

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

+15-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
BlazingChain
22
--
33

4+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.tommyettinger/blazingchain/badge.svg?style=plastic)](https://maven-badges.herokuapp.com/maven-central/com.github.tommyettinger/blazingchain)
5+
46
This one-file library can be used to compress Java/JVM Strings with LZ-String encoding, as developed by
57
[pieroxy](https://github.com/pieroxy/lz-string) for JavaScript and continued by rufushuang in a Java port.
68
This code is a cleaned-up and optimized copy of rufushuang's
@@ -30,8 +32,19 @@ inner classes, and a few other performance tweaks, like appending to one StringB
3032
earlier approach of making an ArrayList of boxed Characters, appending to that, and then re-appending
3133
each Character to another StringBuilder. If premature optimization is the root of all evil, I need an
3234
exorcist, but thankfully the code is small enough that not too much extra work was needed in the
33-
original Java code. Documentation should be added at some point, but the method names are straightforward
34-
and the API surface is small at 8 methods, half for compression and half for decompression.
35+
original Java code. Javadocs are available in the code and on Maven Central, but the method names are
36+
clear and the API surface is small at 8 methods, half for compression and half for decompression.
37+
38+
Usage
39+
---
40+
41+
You can get this version (which should be compatible with lz-string 1.4.4)
42+
[using this info on Maven Central](http://search.maven.org/#artifactdetails%7Ccom.github.tommyettinger%7Cblazingchain%7C1.4.4%7Cjar).
43+
That page provides dependency info for many build tools including Maven, Gradle, Ivy, SBT, and Lein.
44+
There should be a release on GitHub as well.
45+
46+
Other
47+
---
3548

3649
The name is a play on the LZ in Blazing and LZ-String, and Chain being a String-like object, but is also
3750
a reference to [an obscure, no-longer-canon group](http://starwars.wikia.com/wiki/Blazing_Chain) from

pom.xml

+2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
<version>1.4.4</version>
1010
<description>LZ-String encoding for Java; cross-platform to desktop, GWT, and Android at the minimum.
1111
</description>
12+
<name>BlazingChain</name>
13+
1214

1315
<url>https://github.com/tommyettinger/BlazingChain</url>
1416

0 commit comments

Comments
 (0)