Skip to content

Commit ddbe7f1

Browse files
committed
Update the README.md to reflect the release of Dagger 2.0, fixing up some filler text, updating versions, and pointing at the right download/repository sources.
1 parent 85f8347 commit ddbe7f1

File tree

1 file changed

+40
-31
lines changed

1 file changed

+40
-31
lines changed

README.md

Lines changed: 40 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -20,60 +20,72 @@ Both versions have benefitted from strong involvement from Square, Google, and o
2020
Status
2121
------
2222

23-
- ***Release Version:* N/A**
24-
- ***Pre-Release Version:* N/A**
25-
- ***Snapshot Version:* 2.0-SNAPSHOT**
23+
- ***Release Version:* 2.0**
24+
- ***Snapshot Version:* 2.1-SNAPSHOT**
2625

2726
Dagger is currently in active development, primarily internally at Google, with regular pushes
2827
to the open-source community. Snapshot releases are auto-deployed to sonatype's central maven
29-
repository on a clean build with the version tag `2.0-SNAPSHOT`.
30-
31-
Dagger 2.0 is pre-alpha and should be used with caution, though it is usable. Stable
32-
pre-releases will be made as stable points in 2.0's development occur.
28+
repository on a clean build with the version `2.1-SNAPSHOT`.
3329

3430
Documentation
3531
-------------
3632

37-
The Dagger project will undergo a documentation re-vamp in preparation for 2.0. In the mean-time,
38-
you can get an initial picture of Dagger 2.0's direction from [the original proposal][proposal],
39-
[this talk by Greg Kick][gaktalk], and discussions on the [email protected]
40-
mailing list.
33+
You can [find the dagger documentation here][website] which has extended usage
34+
instructions and other useful information. Substantial usage information can be
35+
found in the [API documentation][20api].
4136

42-
Also, Javadocs are updated on every merge and are [available here][latestapi]
37+
You can also learn more from [the original proposal][proposal],
38+
[this talk by Greg Kick][gaktalk], and on discussions on the [email protected]
39+
mailing list.
4340

4441
Installation
4542
--------
4643

47-
You will need to include the `dagger-${dagger.version}.jar` in your
48-
application's runtime. In order to activate code generation you will need to
49-
include `dagger-compiler-${dagger.version}.jar` in your build at compile time.
44+
You will need to include the `dagger-2.0.jar` in your application's runtime.
45+
In order to activate code generation and generate implementations to manage
46+
your graph you will need to include `dagger-compiler-2.0.jar` in your build
47+
at compile time.
5048

51-
In a Maven project, one would include the runtime in the dependencies section
52-
of your `pom.xml` (replacing `${dagger.version}` with the appropriate current
53-
release), and the `dagger-compiler` artifact as an "optional" or "provided"
49+
In a Maven project, one would include the `dagger` artifact in the dependencies section
50+
of your `pom.xml` and the `dagger-compiler` artifact as either an `optional` or `provided`
5451
dependency:
5552

5653
```xml
5754
<dependencies>
5855
<dependency>
5956
<groupId>com.google.dagger</groupId>
6057
<artifactId>dagger</artifactId>
61-
<version>${dagger.version}</version>
58+
<version>2.0</version>
6259
</dependency>
6360
<dependency>
6461
<groupId>com.google.dagger</groupId>
6562
<artifactId>dagger-compiler</artifactId>
66-
<version>${dagger.version}</version>
63+
<version>2.0</version>
6764
<optional>true</optional>
6865
</dependency>
6966
</dependencies>
7067
```
7168

69+
If you use the beta `dagger-producers` extension (which supplies parallelizable execution graphs),
70+
then you should add this to your maven configuration:
71+
72+
```xml
73+
<dependencies>
74+
<dependency>
75+
<groupId>com.google.dagger</groupId>
76+
<artifactId>dagger-producers</artifactId>
77+
<version>2.0-beta</version>
78+
</dependency>
79+
</dependencies>
80+
```
81+
82+
7283
### Download
7384

7485
* 2.0 (google/dagger)
7586
* [Dagger 2.0 Documentation][website]
76-
* [Dagger 2.0 Javadocs][latestapi]
87+
* [Dagger 2.0 Javadocs][20api]
88+
* [Dagger development Javadocs][latestapi] (from the `master` branch on GitHub)
7789
* [Google's Dagger project site on GitHub][project]
7890
* <a href="https://plus.google.com/118328287768685565185" rel="publisher">Google+ Dagger Project Page</a>
7991
* [Google+ Dagger Users Community][community]
@@ -82,10 +94,11 @@ dependency:
8294
* [Square Open Source Community][squarecommunity]
8395

8496

85-
Upon release, downloadable .jars will appear via search on Maven Central. You'll need
86-
[Dagger][dl-dagger], [dagger-compiler][dl-dagger-compiler] and [javax.inject][dl-inject].
97+
If you do not use maven, gradle, ivy, or other build systems that consume maven-style binary
98+
artifacts, they can be downloaded directly via the [Maven Central Repository][mavensearch].
8799

88-
Pre-release directly downloadable jars of the snapshots are available for [dagger][dagger-snap] and [dagger-compiler][dagger-compiler-snap] from sonatype's snapshot repository, and are built on a clean build at head.
100+
Developer snapshots are available from [Sonatype's snapshot repository][dagger-snap], and
101+
are built on a clean build of the GitHub project's master branch.
89102

90103
License
91104
-------
@@ -107,15 +120,11 @@ License
107120

108121

109122

110-
[1]: http://google.github.com/dagger/
111-
[dl-dagger]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.google.dagger%22%20a%3A%22dagger%22
112-
[dl-dagger-compiler]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.google.dagger%22%20a%3A%22dagger-compiler%22
113-
[dl-javawriter]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.squareup%22%20a%3A%22javawriter%22
114-
[dl-inject]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22javax.inject%22%20a%3A%22javax.inject%22
115-
[dagger-snap]: https://oss.sonatype.org/content/repositories/snapshots/com/google/dagger/dagger/2.0-SNAPSHOT/
116-
[dagger-compiler-snap]: https://oss.sonatype.org/content/repositories/snapshots/com/google/dagger/dagger-compiler/2.0-SNAPSHOT/
123+
[mavensearch]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.google.dagger%22
124+
[dagger-snap]: https://oss.sonatype.org/content/repositories/snapshots/com/google/dagger/
117125
[website]: http://google.github.io/dagger
118126
[latestapi]: http://google.github.io/dagger/api/latest/
127+
[20api]: http://google.github.io/dagger/api/2.0/
119128
[gaktalk]: https://www.youtube.com/watch?v=oK_XtfXPkqw
120129
[proposal]: https://github.com/square/dagger/issues/366
121130
[project]: http://github.com/google/dagger/

0 commit comments

Comments
 (0)