Skip to content

Commit

Permalink
Update README.md (#58)
Browse files Browse the repository at this point in the history
  • Loading branch information
jraska authored May 24, 2021
1 parent eb87cf3 commit 51d896f
Showing 1 changed file with 9 additions and 42 deletions.
51 changes: 9 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
### JCenter Update
- Falcon is currently published on JCenter - it will serve packages [until February 1st 2022](https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-chartcenter/). Falcon packages will be migrated to Maven Central before that - [see issue](https://github.com/jraska/Falcon/issues/52). Thanks for using Falcon! :)

# Falcon
**Take Android screenshots with Falcons bright eye!**

*Includes dialogs, toasts and all other extra windows in your screenshot.*

[![Build Status](https://travis-ci.org/jraska/Falcon.svg?branch=master)](https://travis-ci.org/jraska/Falcon)
[![Sample](https://img.shields.io/badge/Download-Sample-blue.svg)](https://drive.google.com/file/d/0B0T1YjC17C-rQ25taHBXSXE2Uzg/view?usp=sharing)
[![License](https://img.shields.io/badge/license-Apache%202.0-green.svg) ](https://github.com/jraska/Falcon/blob/master/LICENSE)
[![Download](https://api.bintray.com/packages/jraska/maven/com.jraska%3Afalcon/images/download.svg) ](https://bintray.com/jraska/maven/com.jraska%3Afalcon/_latestVersion)
[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Falcon-green.svg?style=true)](https://android-arsenal.com/details/1/2793)


Expand All @@ -28,53 +23,27 @@ Check falcon-sample and its android tests for more example usage.

Grab via Gradle:
```groovy
implementation 'com.jraska:falcon:2.1.1'
```

## Spoon Compat

[Spoon][Spoon] is really great library, but it also does not include dialogs and other extra windows in its screenshots.
To keep using Spoon with advantage of Falcon you can use `FalconSpoon` class.

#### Usage of Spoon Compat

```java
@Rule
public final FalconSpoonRule falconSpoonRule = new FalconSpoonRule();

@Test
public void awesomeTest() {
...
File screenshot = FalconSpoonRule.screenshot(activity, tag);
...
}
```
#### Gradle
```groovy
androidTestImplementation 'com.jraska:falcon:2.1.1'
androidTestImplementation 'com.jraska:falcon-spoon-compat:2.1.1'
implementation 'com.jraska:falcon:2.2.0'
```


#### Spoon 1.X Compatibility
## Q&A
*Is Falcon on Maven Central?*

Spoon version 2.0 is not released yet, so if you use version 1.X use Falcon 1.0.4.
```groovy
androidTestImplementation 'com.jraska:falcon:1.0.4'
androidTestImplementation 'com.jraska:falcon-spoon-compat:1.0.4'
```
Yes! Starting with version `2.2.0`.

*Why another screenshot library?*

## Q&A
There are plenty of great screenshot libraries, but all of them miss Dialogs, Toasts and other extra windows in Activity. Not this one!

*Why is Falcon crashing on Android 9 Pie?*
*Why is Falcon crashing on Android 9 or higher?*

You are most likely not using the latest version of Falcon. Android 9 is supported from Falcon version `2.1.0`. Some changes were needed since we use some reflection to make the screenshots possible.

*Why another screenshot library?*

There are plenty of great screenshot libraries, but all of them miss Dialogs, Toasts and other extra windows in Activity. Not this one!
## Spoon Compat - Deprecated

[Here](https://github.com/jraska/Falcon/tree/2.1.1#spoon-compat) you can find the instructions to use [Falcon 2.1.1](https://github.com/jraska/Falcon/tree/2.1.1#spoon-compat) with [Spoon](https://github.com/square/spoon). Spoon Compat support was discontinued as [Spoon](https://github.com/square/spoon) was [last released in 2017](https://github.com/square/spoon/releases. The Spoon Compat artifacts are present on jcenter only.

## License

Expand All @@ -91,5 +60,3 @@ There are plenty of great screenshot libraries, but all of them miss Dialogs, To
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

[Spoon]: https://github.com/square/spoon

0 comments on commit 51d896f

Please sign in to comment.