jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: Sonar -> Flipper

Browse Source 
Summary: Kick off the rename.

Reviewed By: jknoxville

Differential Revision: D9044214

fbshipit-source-id: 86e7b3aeef8c972f18499185c291867751068a2d
This commit is contained in:
Pascal Hartig
2018-07-31 09:03:32 -07:00
committed by Pascal Hartig
parent d931a563d1
commit 6bfdb8d114
1 changed files with 23 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -1,28 +1,33 @@
# Sonar [![Build Status](https://travis-ci.org/facebook/Sonar.svg?branch=master)](https://travis-ci.org/facebook/Sonar) # Flipper [![Build Status](https://travis-ci.org/facebook/flipper.svg?branch=master)](https://travis-ci.org/facebook/flipper)
Sonar is a platform for debugging mobile apps on iOS and Android. Visualize, inspect, and control your apps from a simple desktop interface. Use Sonar as is or extend it using the plugin API. ---
![Sonar](/website/static/img/splash@2x.png) **Flipper, formerly Sonar, is currently in the process of being renamed. This may cause some inconsistencies until everything is in place. We apologize for any inconvience caused.**
---
Flipper is a platform for debugging mobile apps on iOS and Android. Visualize, inspect, and control your apps from a simple desktop interface. Use Flipper as is or extend it using the plugin API.
![Flipper](/website/static/img/splash@2x.png)
## Mobile development ## Mobile development
Sonar aims to be your number one companion for mobile app development on iOS and Android. Therefore, we provide a bunch of useful tools including a log viewer, interactive layout inspector, and network inspector. Flipper aims to be your number one companion for mobile app development on iOS and Android. Therefore, we provide a bunch of useful tools including a log viewer, interactive layout inspector, and network inspector.
## Extending Sonar ## Extending Flipper
Sonar is built as a platform. In addition to using the tools already included, you can create your own plugins to visualize and debug data from your mobile apps. Sonar takes care of sending data back and forth, calling functions, and listening for events on the mobile app. Flipper is built as a platform. In addition to using the tools already included, you can create your own plugins to visualize and debug data from your mobile apps. Flipper takes care of sending data back and forth, calling functions, and listening for events on the mobile app.
## Contributing to Sonar ## Contributing to Flipper
Both Sonar's desktop app and native mobile SDKs are open-source and MIT licensed. This enables you to see and understand how we are building plugins, and of course join the community and help improve Sonar. We are excited to see what you will build on this platform. Both Flipper's desktop app and native mobile SDKs are open-source and MIT licensed. This enables you to see and understand how we are building plugins, and of course join the community and help improve Flipper. We are excited to see what you will build on this platform.
# In this repo # In this repo
This repository includes all parts of Sonar. This includes: This repository includes all parts of Flipper. This includes:
* Sonar's desktop app built using [Electron](https://electronjs.org) (`/src`) * Flipper's desktop app built using [Electron](https://electronjs.org) (`/src`)
* native Sonar SDKs for iOS (`/iOS`) * native Flipper SDKs for iOS (`/iOS`)
* native Sonar SDKs for Android (`/android`) * native Flipper SDKs for Android (`/android`)
* Plugins: * Plugins:
* Logs (`/src/device-plugins/logs`) * Logs (`/src/device-plugins/logs`)
* Layout inspector (`/src/plugins/layout`) * Layout inspector (`/src/plugins/layout`)
@@ -31,11 +36,11 @@ This repository includes all parts of Sonar. This includes:
# Getting started # Getting started
Please refer to our [Getting Started guide](https://fbsonar.com/docs/getting-started.html) to set up Sonar. Please refer to our [Getting Started guide](https://fbflipper.com/docs/getting-started.html) to set up Flipper.
## Requirements ## Requirements
* macOS (while Sonar is buildable using other systems as well, only macOS is officially supported) * macOS (while Flipper is buildable using other systems as well, only macOS is officially supported)
* node >= 8 * node >= 8
* yarn >= 1.5 * yarn >= 1.5
* iOS developer tools (for developing iOS plugins) * iOS developer tools (for developing iOS plugins)
@@ -47,8 +52,8 @@ Please refer to our [Getting Started guide](https://fbsonar.com/docs/getting-sta
### Running from source ### Running from source
``` ```
git clone https://github.com/facebook/Sonar.git git clone https://github.com/facebook/flipper.git
cd Sonar cd flipper
yarn yarn
yarn start yarn start
``` ```
@@ -78,9 +83,9 @@ Start up an android emulator and run the following in the project root:
## Documentation ## Documentation
Find the full documentation for this project at [fbsonar.com](https://fbsonar.com/docs). Find the full documentation for this project at [fbflipper.com](https://fbflipper.com/docs).
## Contributing and license ## Contributing and license
See the CONTRIBUTING file for how to help out. See the CONTRIBUTING file for how to help out.
Sonar is MIT licensed, as found in the LICENSE file. Flipper is MIT licensed, as found in the LICENSE file.