Skip to content

Commit 4f03be0

Browse files
committed
update readme and release notes
1 parent c729bb1 commit 4f03be0

File tree

2 files changed

+69
-24
lines changed

2 files changed

+69
-24
lines changed

README.md

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Flapi - A fluent API generator for Java
2-
## v0.8 [![Build Status](https://travis-ci.org/UnquietCode/Flapi.png?branch=master)](https://travis-ci.org/UnquietCode/Flapi)
2+
## v1.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

@@ -57,39 +57,23 @@ composeEmail()
5757

5858

5959
### [Getting Started](https://github.com/UnquietCode/Flapi/wiki/Getting-Started)
60-
If you are using Maven (or Gradle, or Ivy) you can download and install to your local repo, or include the following
61-
repository and dependency in your build script:
60+
If you are using Maven (or Gradle, or Ivy) include the following dependency
61+
in your build script:
6262

6363
#### Maven
6464
```xml
65-
<repository>
66-
<id>uqc</id>
67-
<name>UnquietCode Repository</name>
68-
<url>http://www.unquietcode.com/maven/releases</url>
69-
</repository>
70-
71-
...
72-
7365
<dependency>
74-
<groupId>unquietcode.tools.flapi</groupId>
66+
<groupId>com.unquietcode.tools.flapi</groupId>
7567
<artifactId>flapi</artifactId>
76-
<version>0.8</version>
68+
<version>1.0</version>
7769
<scope>test</scope>
7870
</dependency>
7971
```
8072

8173
#### Gradle
8274
```groovy
83-
repositories {
84-
maven {
85-
url 'http://www.unquietcode.com/maven/releases'
86-
}
87-
}
88-
89-
...
90-
9175
dependencies {
92-
testCompile 'unquietcode.tools.flapi:flapi:0.8'
76+
testCompile 'com.unquietcode.tools.flapi:flapi:1.0'
9377
}
9478
```
9579

@@ -122,8 +106,11 @@ The original blog post describing Flapi.
122106

123107

124108
### What's the project's status?
125-
Version 0.8 has been released, and includes a new Gradle build plugin, support for
126-
block mixins, and more. See the [Release Notes](./VERSION.md) for the full details.
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
111+
[Upgrade Guide](https://github.com/UnquietCode/Flapi/wiki/Upgrading-from-0.x-Development-Versions)
112+
to see how to upgrade, since some deprecated features have been removed.
113+
See the [Release Notes](./VERSION.md) for the full release notes.
127114

128115
### Problems?
129116
Use the [issue tracker](https://github.com/UnquietCode/Flapi/issues) to report problems encountered or new

VERSION.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,61 @@
1+
# Version 1.0
2+
We did it everyone. You can all go home now.
3+
4+
### Upgrade Guide (#225)
5+
There is an [Upgrade Guide](https://github.com/UnquietCode/Flapi/wiki/Upgrading-from-0.x-Development-Versions)
6+
available which can help early adopters migrate
7+
from a `0.x` development version to the new 1.0
8+
release.
9+
10+
### Remove Deprecated Things (#212)
11+
Part of the upgrade to 1.0 is removing deprecated
12+
elements from the codebase. The upgrade guide above
13+
goes into more detail about what to expect.
14+
15+
### Gradle Plugin Handles Full Descriptors (#222)
16+
You can pass full descriptors to the gradle plugin.
17+
This is a cool feature enabled by the fact that the
18+
gradle plugin script is dynamic, whereas the maven
19+
pom file is just a lifeless XML document. So this
20+
small change means you can just build a descriptor
21+
in your build script instead of in a separate class,
22+
if you wish.
23+
24+
### Group ID has Changed (#200)
25+
The Maven repository group ID has been changed to conform to the
26+
Sonatype central repository rules. Previously the high level package
27+
name was unquietcode.tools.flapi but now it is com.unquietcode.tools.flapi.
28+
The upshot of making this change is that now Flapi and all of its
29+
dependencies are hosted in the Maven central repository.
30+
31+
#### Removed Deprecated `flapi.descriptor.class` Property
32+
The `flapi.descriptor.class` property used in the build plugin
33+
configurations has been removed after being deprecated for several
34+
releases. You can use the comma-separated version named
35+
`flapi.descriptor.classes` instead.
36+
37+
#### `build-project` is Now `flapi-build-project` (#193)
38+
This change brings the build-project naming in line with the
39+
convention used by the other modules of prefixing with
40+
`flapi-` followed by the module name.
41+
42+
#### Introduction of Generics in Builder Methods
43+
Some method signatures now have generics where before they
44+
did not. *This may cause warnings*. Generally wherever a
45+
`Class` parameter was accepted it is now `Class<?>`.
46+
The same goes for `Enum`, *etc*.
47+
48+
#### `Start` Object is Now Untyped (again)
49+
The `Start` object is no longer typed as `Start<Void>` but just
50+
`Start`. The newer `Head<?>` wrapper can be used instead, either
51+
with `Void` or some other return type (and indeed `Start` is now
52+
just an alias for `Head<Void>`).
53+
54+
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).
56+
57+
------------------------------------------------
58+
159
# Version 0.8
260
This version includes several key features, and is also intended to be the last
361
feature release before 1.0.

0 commit comments

Comments
 (0)