Skip to content

Commit e611df9

Browse files
committed
Update readme to our new standard.
1 parent 71ea9b1 commit e611df9

File tree

3 files changed

+29
-59
lines changed

3 files changed

+29
-59
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
# Contributing to Durian
22

33
Pull requests are welcome, preferably against `master`.
4-
5-
Every successful Travis CI build on branch `master` is automatically published to [`https://oss.sonatype.org/content/repositories/snapshots`](https://oss.sonatype.org/content/repositories/snapshots/com/diffplug/), and its javadoc are published [here](http://diffplug.github.io/durian-rx/javadoc/snapshot/).
6-
74
## Build instructions
85

96
It's a bog-standard gradle build.
@@ -26,13 +23,13 @@ By contributing your code, you agree to license your contribution under the term
2623
All files are released with the Apache 2.0 license as such:
2724

2825
```
29-
Copyright 2015 DiffPlug
26+
Copyright 2020 DiffPlug
3027
3128
Licensed under the Apache License, Version 2.0 (the "License");
3229
you may not use this file except in compliance with the License.
3330
You may obtain a copy of the License at
3431
35-
http://www.apache.org/licenses/LICENSE-2.0
32+
https://www.apache.org/licenses/LICENSE-2.0
3633
3734
Unless required by applicable law or agreed to in writing, software
3835
distributed under the License is distributed on an "AS IS" BASIS,

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,26 @@
22

33
<!---freshmark shields
44
output = [
5-
link(shield('Maven artifact', 'mavenCentral', '{{group}}:{{name}}', 'blue'), 'https://bintray.com/{{org}}/opensource/{{name}}/view'),
6-
link(shield('Latest version', 'latest', '{{stable}}', 'blue'), 'https://github.com/{{org}}/{{name}}/releases/latest'),
7-
link(shield('Javadoc', 'javadoc', 'OK', 'blue'), 'https://javadoc.io/doc/com.diffplug.durian/durian-rx/{{stable}}/'),
8-
link(shield('License Apache', 'license', 'Apache', 'blue'), 'https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)'),
9-
'',
10-
link(shield('Changelog', 'changelog', '{{version}}', 'brightgreen'), 'CHANGES.md'),
11-
link(image('Travis CI', 'https://travis-ci.org/{{org}}/{{name}}.svg?branch=master'), 'https://travis-ci.org/{{org}}/{{name}}'),
12-
link(shield('Live chat', 'gitter', 'live chat', 'brightgreen'), 'https://gitter.im/diffplug/durian')
13-
].join('\n');
5+
link(shield('Maven central', 'mavencentral', 'com.diffplug.durian:durian-rx', 'blue'), 'https://search.maven.org/artifact/com.diffplug.durian/durian-rx'),
6+
link(shield('Apache 2.0', 'license', 'apache-2.0', 'blue'), 'https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)'),
7+
'',
8+
link(shield('Changelog', 'changelog', versionLast, 'brightgreen'), 'CHANGES.md'),
9+
link(shield('Javadoc', 'javadoc', 'yes', 'brightgreen'), 'https://javadoc.io/doc/com.diffplug.durian/durian-rx/{{versionLast}}/'),
10+
link(shield('Live chat', 'gitter', 'chat', 'brightgreen'), 'https://gitter.im/diffplug/durian'),
11+
link(image('JitCI', 'https://jitci.com/gh/diffplug/durian-rx/svg'), 'https://jitci.com/gh/diffplug/durian-rx')
12+
].join('\n');
1413
-->
15-
[![Maven artifact](https://img.shields.io/badge/mavenCentral-com.diffplug.durian%3Adurian--rx-blue.svg)](https://bintray.com/diffplug/opensource/durian-rx/view)
16-
[![Latest version](https://img.shields.io/badge/latest-3.0.1-blue.svg)](https://github.com/diffplug/durian-rx/releases/latest)
17-
[![Javadoc](https://img.shields.io/badge/javadoc-OK-blue.svg)](https://javadoc.io/doc/com.diffplug.durian/durian-rx/3.0.1/)
18-
[![License Apache](https://img.shields.io/badge/license-Apache-blue.svg)](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0))
14+
[![Maven central](https://img.shields.io/badge/mavencentral-com.diffplug.durian%3Adurian--rx-blue.svg)](https://search.maven.org/artifact/com.diffplug.durian/durian-rx)
15+
[![Apache 2.0](https://img.shields.io/badge/license-apache--2.0-blue.svg)](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0))
1916

2017
[![Changelog](https://img.shields.io/badge/changelog-3.0.1-brightgreen.svg)](CHANGES.md)
21-
[![Travis CI](https://travis-ci.org/diffplug/durian-rx.svg?branch=master)](https://travis-ci.org/diffplug/durian-rx)
22-
[![Live chat](https://img.shields.io/badge/gitter-live_chat-brightgreen.svg)](https://gitter.im/diffplug/durian)
18+
[![Javadoc](https://img.shields.io/badge/javadoc-yes-brightgreen.svg)](https://javadoc.io/doc/com.diffplug.durian/durian-rx/3.0.1/)
19+
[![Live chat](https://img.shields.io/badge/gitter-chat-brightgreen.svg)](https://gitter.im/diffplug/durian)
20+
[![JitCI](https://jitci.com/gh/diffplug/durian-rx/svg)](https://jitci.com/gh/diffplug/durian-rx)
2321
<!---freshmark /shields -->
2422

2523
<!---freshmark javadoc
26-
output = prefixDelimiterReplace(input, 'https://javadoc.io/doc/com.diffplug.durian/durian-rx/', '/', stable);
24+
output = prefixDelimiterReplace(input, 'https://javadoc.io/static/com.diffplug.durian/durian-rx/', '/', versionLast);
2725
-->
2826
DurianRx unifies RxJava's [Observable](http://reactivex.io/documentation/observable.html) with Guava's [ListenableFuture](https://code.google.com/p/guava-libraries/wiki/ListenableFutureExplained). If you happen to be using SWT as a widget toolkit, then you'll want to look at [DurianSwt](https://github.com/diffplug/durian-swt) as well.
2927

build.gradle

Lines changed: 13 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
plugins {
22
id "com.diffplug.blowdryer"
3-
id "com.github.ben-manes.versions"
4-
id "com.diffplug.gradle.osgi.bndmanifest"
5-
id "com.diffplug.gradle.spotless"
6-
id "com.jfrog.bintray"
7-
id "com.github.spotbugs" version '3.0.0'
3+
id "com.diffplug.spotless-changelog"
4+
id "jp.skypencil.spotbugs.snom" version '0.4.9'
85
}
96

7+
spotlessChangelog {
8+
changelogFile 'CHANGES.md'
9+
}
10+
11+
apply from: 干.file('base/changelog.gradle')
1012
apply plugin: 'java-library'
1113
apply from: 干.file('base/java8.gradle')
1214
apply from: 干.file('base/osgi.gradle')
15+
apply from: 干.file('spotless/freshmark.gradle')
1316

1417
dependencies {
1518
implementation "com.diffplug.durian:durian-core:${VER_DURIAN}"
@@ -27,7 +30,8 @@ ext.javadoc_links = [
2730
"https://javadoc.io/doc/com.diffplug.durian/durian-concurrent/${VER_DURIAN}",
2831
"https://javadoc.io/doc/com.diffplug.durian/durian-debug/${VER_DURIAN_DEBUG}",
2932
"https://javadoc.io/doc/io.reactivex.rxjava2/rxjava/${VER_RXJAVA}",
30-
'https://docs.oracle.com/javase/8/docs/api/'].join(' ')
33+
'https://docs.oracle.com/javase/8/docs/api/'
34+
].join(' ')
3135
apply from: 干.file('base/maven.gradle')
3236
apply from: 干.file('base/bintray.gradle')
3337

@@ -41,40 +45,11 @@ spotless {
4145
importOrderFile 'gradle/spotless.importorder' // An import ordering file, exported from Eclipse
4246
eclipse().configFile 'gradle/spotless.eclipseformat.xml' // XML file dumped out by the Eclipse formatter
4347
}
44-
format 'misc', {
45-
target '*.gitignore', '*.gradle', '*.md', '.ci/*.sh'
46-
indentWithTabs()
47-
trimTrailingWhitespace()
48-
endWithNewline()
49-
}
50-
freshmark {
51-
target '*.md'
52-
propertiesFile('gradle.properties')
53-
properties {
54-
it.put('group', group)
55-
}
56-
}
5748
}
5849

59-
//////////////
60-
// FINDBUGS //
61-
//////////////
62-
spotbugs {
63-
sourceSets = [sourceSets.main] // don't check the test code
64-
ignoreFailures = false // bug free or it doesn't ship!
65-
reportsDir = file('build/findbugs')
66-
effort = 'max' // min|default|max
67-
reportLevel = 'low' // low|medium|high (low = sensitive to even minor mistakes)
68-
omitVisitors = [] // bugs that we want to ignore
69-
}
70-
// HTML instead of XML
71-
tasks.withType(com.github.spotbugs.SpotBugsTask) {
72-
reports {
73-
xml.enabled = false
74-
html.enabled = true
75-
}
76-
}
77-
// we'll want the findbugs annotations (they don't have a 3.0.1 version)
50+
////////////////////////
51+
// SPOTBUGS (someday) //
52+
////////////////////////
7853
dependencies {
7954
compileOnly 'com.google.code.findbugs:annotations:3.0.0'
8055
compileOnly 'com.google.code.findbugs:jsr305:3.0.0'

0 commit comments

Comments
 (0)