Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
LossyDragon committed Oct 21, 2023
1 parent b2b969e commit f319a34
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 24 deletions.
26 changes: 26 additions & 0 deletions .run/javasteam [Generated Classes].run.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="javasteam [Generated Classes]" type="GradleRunConfiguration" factoryName="Gradle">
<ExternalSystemSettings>
<option name="executionName" />
<option name="externalProjectPath" value="$PROJECT_DIR$" />
<option name="externalSystemIdString" value="GRADLE" />
<option name="scriptParameters" value="" />
<option name="taskDescriptions">
<list />
</option>
<option name="taskNames">
<list>
<option value="generateProto" />
<option value="generateSteamLanguage" />
<option value="generateProjectVersion" />
</list>
</option>
<option name="vmOptions" />
</ExternalSystemSettings>
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
<DebugAllEnabled>false</DebugAllEnabled>
<RunAsTest>false</RunAsTest>
<method v="2" />
</configuration>
</component>
39 changes: 15 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# JavaSteam
[![Java CI/CD](https://github.com/Longi94/JavaSteam/actions/workflows/javasteam-build.yml/badge.svg)](https://github.com/Longi94/JavaSteam/actions/workflows/javasteam-build.yml)
[![Java CI/CD](https://github.com/Longi94/JavaSteam/actions/workflows/javasteam-build-push.yml/badge.svg)](https://github.com/Longi94/JavaSteam/actions/workflows/javasteam-build.yml)
[![Maven Central](https://img.shields.io/maven-central/v/in.dragonbra/javasteam)](https://mvnrepository.com/artifact/in.dragonbra/javasteam)
[![Discord](https://img.shields.io/discord/420907597906968586.svg)](https://discord.gg/8F2JuTu)

Expand Down Expand Up @@ -46,38 +46,29 @@ Maven

**3. Add the appropriate cryptography dependency to your project. JavaSteam depends on this.**

Gradle
```groovy
// https://mvnrepository.com/artifact/org.bouncycastle/bcprov-jdk15on
implementation 'org.bouncycastle:bcprov-jdk15on:x.y.z>' // NON-ANDROID ONLY
// https://mvnrepository.com/artifact/com.madgag.spongycastle/prov
implementation 'com.madgag.spongycastle:prov:w.x.y.z' // ANDROID ONLY
```
[Android | Spongy Castle](https://mvnrepository.com/artifact/com.madgag.spongycastle/prov)

[Non-Android | Bouncy Castle](https://mvnrepository.com/artifact/org.bouncycastle/bcprov-jdk18on)

Maven
```xml
<!-- https://mvnrepository.com/artifact/org.bouncycastle/bcprov-jdk15on -->
<dependency> <!-- NON-ANDROID ONLY -->
<groupId>org.bouncycastle</groupId>
<artifactId>bcprov-jdk15on</artifactId>
<version>x.y.z</version>
</dependency>
<!-- https://mvnrepository.com/artifact/com.madgag.spongycastle/prov -->
<dependency> <!-- ANDROID ONLY -->
<groupId>com.madgag.spongycastle</groupId>
<artifactId>prov</artifactId>
<version>w.x.y.z</version>
</dependency>
```

## Getting Started

You can head to the very short [Getting Started](https://github.com/Longi94/JavaSteam/wiki/Getting-started) page or take a look at the [samples](https://github.com/Longi94/JavaSteam/tree/master/javasteam-samples/src/main/java/in/dragonbra/javasteamsamples) to get you started with using this library. There some [open-source projects](https://github.com/Longi94/JavaSteam/wiki/Samples) too you can check out.
You can head to the very short [Getting Started](https://github.com/Longi94/JavaSteam/wiki/Getting-started) page or take a look at the [samples](https://github.com/Longi94/JavaSteam/tree/master/javasteam-samples/src/main/java/in/dragonbra/javasteamsamples) to get you started with using this library.

There some [open-source projects](https://github.com/Longi94/JavaSteam/wiki/Samples) too you can check out.

The [wiki](https://github.com/Longi94/JavaSteam/wiki) may also be useful to check out for other info.

## Build

Full build:<br>

```./gradlew build -x signMavenJavaPublication```

Generated classes:<br>

```./gradlew generateProto generateSteamLanguage generateProjectVersion```

## Contributing

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

0 comments on commit f319a34

Please sign in to comment.