Skip to content

Commit

Permalink
Expand usage information in README
Browse files Browse the repository at this point in the history
  • Loading branch information
spartusch committed Jan 10, 2021
1 parent f39cb70 commit f056da0
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 11 deletions.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,22 @@ these URLs.
- Microsoft Excel will now automatically import the response from the URL in your web
query whenever it imports external data

## How to build and publish this library
## How to use this library

Build this library with Gradle and publish it, e.g. locally:
```
./gradlew publishToMavenLocal
Add Jitpack as a repository to your project and add a dependency for excel-web-query in order to
use this library (the code snippet below uses Gradle's Kotlin DSL):
```
repositories {
maven { url = uri("https://jitpack.io") }
}
You can also build a base image for Docker:
```
./bin/build-image.sh
dependencies {
implementation("com.github.spartusch:excel-web-query:latest.release")
}
```

## How to use this library

Usage is quite simple: Create a new `WebQuery` by calling `WebQueryFactory.create`.
The actual usage of the library is straightforward:
Create a new `WebQuery` by calling `WebQueryFactory.create`.
This library is written in Kotlin but tested with Java and Kotlin.

### Example on how to create a `ResponseEntity` for Spring MVC
Expand Down Expand Up @@ -59,3 +60,15 @@ headers[HttpHeaders.CONTENT_DISPOSITION] = WebQuery.getContentDisposition("webqu
val response = ResponseEntity(ByteArrayResource(webQuery.contentBytes), headers, HttpStatus.OK)
```

## How to build and publish this library

Build this library with Gradle and publish it, e.g. locally:
```
./gradlew publishToMavenLocal
```

You can also build a base image for Docker:
```
./bin/build-image.sh
```
2 changes: 1 addition & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ dependencies {
}

group = "com.github.spartusch"
version = "2.0.0"
version = "2.0.1"

val sourcesJar by tasks.creating(Jar::class) {
archiveClassifier.set("sources")
Expand Down

0 comments on commit f056da0

Please sign in to comment.