Skip to content

Update README.md #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LossyDragon merged 2 commits into from
Dec 29, 2021
Merged

Update README.md #188

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d93110
Update README.md
LossyDragon Dec 23, 2021
aa99dec
Update README.md
LossyDragon Dec 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,40 @@ Work-in-progress Java port of [SteamKit2](https://github.com/SteamRE/SteamKit).

## Download

Currently only [snapshot builds](https://oss.sonatype.org/content/repositories/snapshots/in/dragonbra/javasteam/1.0.0-SNAPSHOT/) are available on Sonatype's snapshot repository.
Version 1.0.0 is available through [Maven](https://mvnrepository.com/artifact/in.dragonbra/javasteam)

If you get a `java.security.InvalidKeyException: Illegal key size or default parameters` exception when trying to encrypt a message you need to download the [Unlimited Strength Jurisdiction Policy Files](http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html) and place them under `${java.home}/jre/lib/security/`. See [this stackoverflow question](https://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters).

**1. Add the snapshot repository to your build.**
**1. Add the repository to your build.**

Gradle
```groovy
repositories {
maven {
url 'https://oss.sonatype.org/content/repositories/snapshots/'
}
mavenCentral()
}
```

Maven
```xml
<repository>
<id>snapshots-repo</id>
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
<id>central</id>
<url>https://repo.maven.apache.org/maven2</url>
</repository>
```

**2. Add the JavaSteam dependency to your project.**

Gradle
```groovy
implementation 'in.dragonbra:javasteam:1.0.0-SNAPSHOT'
implementation 'in.dragonbra:javasteam:1.0.0'
```

Maven
```xml
<dependency>
<groupId>in.dragonbra</groupId>
<artifactId>javasteam</artifactId>
<version>1.0.0-SNAPSHOT</version>
<groupId>in.dragonbra</groupId>
<artifactId>javasteam</artifactId>
<version>1.0.0</version>
</dependency>
```

Expand Down Expand Up @@ -75,6 +73,8 @@ You can head to the very short [Getting Started](https://github.com/Longi94/Java

```./gradlew build```

Note: If you are building locally for testing purposes, comment out `signing` and `uploadArchives` in the build.gradle files in order to build successfully.

## Contributing

Contributions to the repository are always welcome! Checkout the [contribution guidelines](CONTRIBUTING.md) to get started.
Expand Down