Skip to content

Commit 9ce1b98

Browse files
committed
Update README for publishing changes to S3 Maven
1 parent 3b48de4 commit 9ce1b98

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
# Backboard
44

5-
[![CircleCI](https://circleci.com/gh/tumblr/Backboard/tree/master.svg?style=svg)](https://circleci.com/gh/tumblr/Backboard/tree/master)
6-
75
A motion-driven animation framework for Android.
86

97
`backboard` is a framework on top of [rebound](http://facebook.github.io/rebound/) that makes it easier to use by coupling it to views and motions.
@@ -19,6 +17,7 @@ A motion-driven animation framework for Android.
1917
## Table of Contents
2018

2119
* [Usage](#usage)
20+
* [Publishing a new version](#publishing-a-new-version)
2221
* [Getting Started](#getting-started)
2322
* [Performers](#performers)
2423
* [Imitators](#imitators)
@@ -32,12 +31,33 @@ A motion-driven animation framework for Android.
3231
Update your `build.gradle` with
3332

3433
```groovy
34+
repositories {
35+
exclusiveContent {
36+
forRepository {
37+
maven {
38+
url "https://a8c-libs.s3.amazonaws.com/android"
39+
}
40+
}
41+
filter {
42+
includeModule "com.tumblr", "backboard"
43+
}
44+
}
45+
}
46+
3547
dependencies {
36-
compile 'com.facebook.rebound:rebound:0.3.8'
37-
compile 'com.tumblr:backboard:0.1.0'
48+
implementation 'com.facebook.rebound:rebound:0.3.8'
49+
implementation 'com.tumblr:backboard:0.2.0'
3850
}
3951
```
4052

53+
## Publishing a new version
54+
55+
In the following cases, the CI will publish a new version with the following format to our S3 Maven repo:
56+
57+
* For each commit in an open PR: `<PR-number>-<commit full SHA1>`
58+
* Each time a PR is merged to `master`: `master-<commit full SHA1>`
59+
* Each time a new tag is created: `{tag-name}`
60+
4161
## Getting Started
4262

4363
Backboard is a framework on top of [rebound](http://facebook.github.io/rebound/) that manages how `Springs` are used and simplifies the

0 commit comments

Comments
 (0)