Skip to content

Commit 322df4f

Browse files
authored
Add details to README (#128)
* Initial beefing * Update README.md
1 parent b34ce67 commit 322df4f

2 files changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
1-
# react-native-owl
1+
# `react-native-owl`
2+
3+
> Visual regression testing for React Native
4+
5+
![Sample of using React Native Owl to generate a visual regression diff](https://raw.githubusercontent.com/FormidableLabs/react-native-owl/main/website/static/images/homepage/mockup-bg.png)
6+
7+
---
28

39
[![github][github-image]][github-url] [![npm][npm-image]][npm-url] [![docs][docs-image]][docs-url] [![Maintenance Status][maintenance-image]](#maintenance-status)
410

5-
> Visual regression testing for React Native
11+
## What is React Native Owl?
12+
13+
React Native Owl is a visual regression testing library for React Native that enables developers to introduce visual regression tests to their apps for iOS and Android. Being heavily inspired by [Detox](https://github.com/wix/Detox), an end-to-end testing and automation framework, this library uses a similar API that makes setting up `react-native-owl` and running the tests locally and on your preferred CI service seamless.
14+
15+
While Detox focuses on end-to-end testing in general, React Native Owl focuses on visual regression testing and helping you catch unexpected changes to the visual appearance of your app over time.
16+
17+
### :rocket: [Check out the official documentation for more details!](https://formidable.com/open-source/react-native-owl/)
618

719
## Installation
820

58.9 KB
Loading

0 commit comments

Comments
 (0)