Skip to content

Commit f4bfebd

Browse files
committed
version notes and info for 2.0 release
1 parent 3e8f403 commit f4bfebd

File tree

2 files changed

+53
-15
lines changed

2 files changed

+53
-15
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Flapi - A fluent API generator for Java
2-
## v1.0 [![Build Status](https://travis-ci.org/UnquietCode/Flapi.png?branch=master)](https://travis-ci.org/UnquietCode/Flapi)
2+
## v2.0 [![Build Status](https://travis-ci.org/UnquietCode/Flapi.png?branch=master)](https://travis-ci.org/UnquietCode/Flapi)
33

44
[![Tip with Gratipay](https://assets.gratipay.com/gratipay.svg)](https://gratipay.com/UnquietCode) [![Tip with Bitcoin](http://www.unquietcode.com/e_e/bitcoin.png)](https://blockchain.info/address/1Ec6mzLpJQvuzXqhxfJz1h9ZwJmoHMW9BX)**Bitcoin**
55

@@ -65,15 +65,15 @@ in your build script:
6565
<dependency>
6666
<groupId>com.unquietcode.tools.flapi</groupId>
6767
<artifactId>flapi</artifactId>
68-
<version>1.0</version>
68+
<version>2.0</version>
6969
<scope>test</scope>
7070
</dependency>
7171
```
7272

7373
#### Gradle
7474
```groovy
7575
dependencies {
76-
testCompile 'com.unquietcode.tools.flapi:flapi:1.0'
76+
testCompile 'com.unquietcode.tools.flapi:flapi:2.0'
7777
}
7878
```
7979

@@ -84,12 +84,12 @@ example is a simple descriptor you can start with.) You can also make use of the
8484
[Maven plugin](https://github.com/UnquietCode/Flapi/wiki/Maven-Build-Plugin), to
8585
perform the code generation.
8686

87-
At the time of writing the project builds fine in JDK 6, however please note that
88-
the automated builds are no longer being run for that release. Future versions will
89-
be built using JDK 8, while still exposing a JDK 7 compatible API, and using JDK 7
90-
as the default target for code generation.
87+
Version 2.x of the project is built against JDK 8, while still exposing a JDK 7
88+
compatible API, but using JDK 8 as the default target for code generation
89+
(selectable down to JDK 5). Version 1.x is built against JDK 7, and has a JDK 6
90+
compatible API.
9191

92-
(PSA: If you are still using JDK 6 or lower, please do something about that soon.)
92+
(PSA: If you are still using JDK 7 or lower, please do something about that soon.)
9393

9494

9595
### Additional Resources
@@ -101,17 +101,23 @@ how to use them. (generated using the very nice tool [docker](https://github.com
101101
* [Examples](https://github.com/UnquietCode/Flapi/wiki/Examples)
102102
Many helpful examples are included on the wiki, corresponding to examples and tests in the src/test directory.
103103

104+
* [Upgrade Guide](https://github.com/UnquietCode/Flapi/wiki/Upgrading-from-0.x-Development-Versions)
105+
If you started using Flapi before version 1.0, check out this guide to see how to upgrade.
106+
104107
* [Blog Post](http://www.unquietcode.com/blog/2012/software/introducing-flapi)
105108
The original blog post describing Flapi.
106109

107110

108111
### What's the project's status?
109-
Version 1.0 has been released, marking a huge milestone in the stability of the code.
110-
If you started using Flapi before this version, check out the
112+
Version 1.0 and 2.0 have been released, marking a huge milestone in the stability of
113+
the code. If you started using Flapi before this version, check out the
111114
[Upgrade Guide](https://github.com/UnquietCode/Flapi/wiki/Upgrading-from-0.x-Development-Versions)
112115
to see how to upgrade, since some deprecated features have been removed.
113116
See the [Release Notes](./VERSION.md) for the full release notes.
114117

118+
Going forward, the 1.x line will only receive important fixes and updates, with all new
119+
development firmly rooted in 2.x / Java 8.
120+
115121
### Problems?
116122
Use the [issue tracker](https://github.com/UnquietCode/Flapi/issues) to report problems encountered or new
117123
feature requests.

VERSION.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
1+
# Version 2.0
2+
This release is all about Java 8, and is more-or-less
3+
identical to the recent 1.0 release but with added
4+
support for the latest version of Java.
5+
6+
### JDK 8 Parameter Names (#218)
7+
Java 8 has built-in support for introspecting method
8+
parameter names when debug compilation is enabled.
9+
Flapi now makes use of these names where available
10+
when scanning an annotated descriptor class.
11+
12+
### JDK 8 Support Classes (#219)
13+
The 2.0 release changes out the `Consumer`, `Supplier`,
14+
and `Function` classes used in Flapi interfaces for
15+
their built-in counterparts. This allows for greater
16+
compatibility and shaves a few runtime classes, at
17+
the expense of requiring a JDK 8 environment.
18+
19+
20+
The full list of tasks and issues included in the release is available on the project's
21+
[Issue Tracker](https://github.com/UnquietCode/Flapi/issues?q=milestone%3A2.0).
22+
23+
------------------------------------------------
24+
125
# Version 1.0
226
We did it everyone. You can all go home now.
327

@@ -51,8 +75,9 @@ The `Start` object is no longer typed as `Start<Void>` but just
5175
with `Void` or some other return type (and indeed `Start` is now
5276
just an alias for `Head<Void>`).
5377

78+
5479
The full list of tasks and issues included in the release is available on the project's
55-
[Issue Tracker](https://github.com/UnquietCode/Flapi/milestones/1.0).
80+
[Issue Tracker](https://github.com/UnquietCode/Flapi/issues?q=milestone%3A1.0).
5681

5782
------------------------------------------------
5883

@@ -87,8 +112,9 @@ demands, creating a more shelf-stable API.
87112
+ [#214]: support for single wildcard generics in method signatures
88113
+ [#213]: new `Start` wrapper type, replacing confusing uses of `Start<Void>`
89114

115+
90116
The full list of tasks and issues included in the release is available on the project's
91-
[Issue Tracker](https://github.com/UnquietCode/Flapi/milestones/0.8).
117+
[Issue Tracker](https://github.com/UnquietCode/Flapi/issues?q=milestone%3A0.8).
92118

93119
------------------------------------------------
94120

@@ -136,8 +162,9 @@ a shortcut to defining your own factory for downstream consumers.
136162
The value for the block chain marker annotation for use in annotated helpers
137163
has been removed through better resolution of generics.
138164

165+
139166
The full list of tasks and issues included in the release is available on the project's
140-
[Issue Tracker](https://github.com/UnquietCode/Flapi/milestones/0.7).
167+
[Issue Tracker](https://github.com/UnquietCode/Flapi/issues?q=milestone%3A0.7).
141168

142169
------------------------------------------------
143170

@@ -171,8 +198,9 @@ Issues are now handled through GitHub, and historical issues have been migrated
171198
+ [FLAPI-190 / #34]: Update docs and wiki with annotations info.
172199
+ [FLAPI-189 / #17]: Move issues from JIRA to GitHub
173200

201+
174202
The full list of tasks and issues included in the release is available on the project's
175-
[Issue Tracker](https://github.com/UnquietCode/Flapi/milestones/0.6).
203+
[Issue Tracker](https://github.com/UnquietCode/Flapi/issues?q=milestone%3A0.6).
176204

177205
------------------------------------------------
178206

@@ -215,6 +243,7 @@ Previously, the wrapper interface was called `$`. Flapi 0.5 has removed all uses
215243
+ [FLAPI-173] - Document method grouping / triggering in wiki.
216244
+ [FLAPI-182] - Create a mailing list / user group for Flapi.
217245

246+
218247
The full list of tasks and issues included in the release is available on the project's
219248
[Issue Tracker](https://github.com/UnquietCode/Flapi/issues?q=milestone%3A0.5+milestone%3A0.5.1).
220249

@@ -312,6 +341,7 @@ A brand new documentation page is available at
312341
+ [FLAPI-124] - Add java.util to class search path.
313342
+ [FLAPI-139] - Create two-column documentation of Flapi features.
314343

344+
315345
The full list of tasks and issues included in the release is available on the project's
316346
[Issue Tracker](https://github.com/UnquietCode/Flapi/issues?q=milestone%3A0.4).
317347

@@ -365,6 +395,7 @@ instead of an object, by piping processes together. Find it in the
365395
+ Watch the video [here](vimeo.com/58855907)
366396
* [FLAPI-123] - Add PipedProcess example to project.
367397

398+
368399
The full list of tasks and issues included in the release is available on the project's
369400
[Issue Tracker](https://github.com/UnquietCode/Flapi/issues?q=milestone%3A0.3).
370401

@@ -423,5 +454,6 @@ This version, 0.1, is an initial beta laying the groundwork for using
423454
Flapi. See the [Examples](https://github.com/UnquietCode/Flapi/wiki/Examples)
424455
in the wiki for more information.
425456

457+
426458
The full list of tasks and issues included in the release is available on the project's
427-
[Issue Tracker](https://github.com/UnquietCode/Flapi/issues?q=milestone%3A0.1).
459+
[Issue Tracker](https://github.com/UnquietCode/Flapi/issues?q=milestone%3A0.1).

0 commit comments

Comments
 (0)