Skip to content

Commit

Permalink
Merge pull request #582 from mmautner/master
Browse files Browse the repository at this point in the history
clarifying intro docs
  • Loading branch information
johnrengelman authored Jun 15, 2020
2 parents 4de0843 + 66cfa11 commit a9f84a7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/docs/introduction/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Introduction

Shadow is a Gradle plugin for combining dependency classes and resources with a project's into a single
Shadow is a Gradle plugin for combining a project's dependency classes and resources into a single
output Jar.
The combined Jar is often referred to a _fat-jar_ or _uber-jar_.
Shadow utilizes `JarInputStream` and `JarOutputStream` to efficiently process dependent libraries
Shadow utilizes [`JarInputStream`](https://docs.oracle.com/javase/8/docs/api/java/util/jar/JarInputStream.html) and [`JarOutputStream`](https://docs.oracle.com/javase/8/docs/api/java/util/jar/JarOutputStream.html) to efficiently process dependent libraries
into the output jar without incurring the I/O overhead of expanding the jars to disk.

## Benefits of Shadow
Expand All @@ -15,7 +15,7 @@ Shadowing a project output has 2 major use cases:

### Executable Distributions

Executable distribution is the main use case for _application_ an be deployed and executed/run in the runtime
Executable distribution is the main use case for deploying an _application_ that can be executed/run in the runtime
environment.
In the case of Shadow, this is a single _uber_ or _fat_ JAR.
The JAR file contains all the application code and dependent libraries to execute (not including the standard JVM
Expand Down

0 comments on commit a9f84a7

Please sign in to comment.