Skip to content

Commit

Permalink
Merge pull request #91 from vorburger/patch-2
Browse files Browse the repository at this point in the history
README clarification; "Java driver of leveldb" was confusing
  • Loading branch information
chirino authored Feb 8, 2017
2 parents 3706b79 + c3beef0 commit ce2074e
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Just add the following jar to your java project:

## Using as a Maven Dependency

You just need to add the following dependency to your Maven pom.
You just need to add the following dependency to your Maven POM:

<dependencies>
<dependency>
Expand All @@ -24,7 +24,9 @@ You just need to add the following dependency to your Maven pom.
</dependency>
</dependencies>

By using the `leveldbjni-all` then the Java driver of leveldb is being used. If you want to use the native drivers, then use the os specific dependency instead of `leveldbjni-all`. For example to use linux 64 bit, then use this dependency:
By using the `leveldbjni-all` dependency, you get the OS specific native drivers for all supported platforms.

If you want to use only one or some but not all native drivers, then directly use the OS specific dependency instead of `leveldbjni-all`. For example to use Linux 64 bit, use this dependency:

<dependencies>
<dependency>
Expand All @@ -34,6 +36,16 @@ By using the `leveldbjni-all` then the Java driver of leveldb is being used. If
</dependency>
</dependencies>

If you have the leveljni native driver DLL/SO library already separately installed e.g. by a package manager (see [issue 90](https://github.com/fusesource/leveldbjni/issues/90)), then you could depend on the Java "launcher" without the JAR containing the OS specific native driver like this:

<dependency>
<groupId>org.fusesource.leveldbjni</groupId>
<artifactId>leveldbjni</artifactId>
<version>1.8</version>
</dependency>

Lastly, another project unrelated to this project separately provides a (less mature) pure Java implementation of LevelDB, see [dain/leveldb](https://github.com/dain/leveldb). Note that both that and this project share the same Maven artefact for the Level DB API interface (org.iq80.leveldb:leveldb-api).


## API Usage:

Expand Down Expand Up @@ -248,7 +260,7 @@ just copy the `leveldbjni-${version}-SNAPSHOT-native-src.zip` artifact
from a platform the does have the tools available then add the
following argument to your maven build:

-Dnative-src-url=file:leveldbjni-${verision}-SNAPSHOT-native-src.zip
-Dnative-src-url=file:leveldbjni-${verision}-SNAPSHOT-native-src.zip

### Build Results

Expand Down

0 comments on commit ce2074e

Please sign in to comment.