Skip to content

Commit

Permalink
Improve README (add more sections) (#1922)
Browse files Browse the repository at this point in the history
update readme
  • Loading branch information
bartekpacia authored Aug 18, 2024
1 parent 8f08a81 commit 54c0f89
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 9 deletions.
35 changes: 26 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# Maestro 🎹
# Maestro

Maestro is the easiest way to automate UI testing for your mobile app.

> [!NOTE]
>
> **Full documentation for Maestro can be found at [maestro.mobile.dev](https://maestro.mobile.dev)**
<img src="https://user-images.githubusercontent.com/847683/187275009-ddbdf963-ce1d-4e07-ac08-b10f145e8894.gif" />


## Why Maestro?

Maestro is built on learnings from its predecessors (Appium, Espresso, UIAutomator, XCTest)
Expand All @@ -21,6 +16,28 @@ Maestro is built on learnings from its predecessors (Appium, Espresso, UIAutomat

## Resources

- :book:&nbsp;&nbsp;Full documentation for Maestro can be found at [**maestro.mobile.dev**](https://maestro.mobile.dev)
- :speech_balloon:&nbsp;&nbsp;Public Slack channel: [**Join the workspace**](https://docsend.com/view/3r2sf8fvvcjxvbtk), then head to the `#maestro` channel
- :page_with_curl:&nbsp;&nbsp;Blog Post: [**Introducing: Maestro — Painless Mobile UI Automation**](https://blog.mobile.dev/introducing-maestro-painless-mobile-ui-automation-bee4992d13c1)
### Documentation

**Available at [maestro.mobile.dev](https://maestro.mobile.dev)**

To get more background on why we built Maestro, read [the Maestro announcement blogpost][blogpost].

### Community

We invite everyone to [join our public Slack channel](https://docsend.com/view/3r2sf8fvvcjxvbtk).

### Contributing

Maestro is an open-source project and we love getting contributions.

To get started, take a look at [issues with the `good first issue` label][good first issues] and [the contributing guide](./CONTRIBUTING.md).

### Built by

[mobile.dev](https://www.mobile.dev)

![](./logo.png)

[good first issues]: https://github.com/mobile-dev-inc/maestro/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22
[blogpost]: https://blog.mobile.dev/introducing-maestro-painless-mobile-ui-automation-bee4992d13c1

Binary file added logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 54c0f89

Please sign in to comment.