From 54c0f8970b9e33759cd84884314f66f7469fa0a1 Mon Sep 17 00:00:00 2001 From: Bartek Pacia Date: Mon, 19 Aug 2024 00:57:42 +0100 Subject: [PATCH] Improve README (add more sections) (#1922) update readme --- README.md | 35 ++++++++++++++++++++++++++--------- logo.png | Bin 0 -> 8195 bytes 2 files changed, 26 insertions(+), 9 deletions(-) create mode 100644 logo.png diff --git a/README.md b/README.md index b2bf71692d..1339c0fd08 100644 --- a/README.md +++ b/README.md @@ -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)** - - ## Why Maestro? Maestro is built on learnings from its predecessors (Appium, Espresso, UIAutomator, XCTest) @@ -21,6 +16,28 @@ Maestro is built on learnings from its predecessors (Appium, Espresso, UIAutomat ## Resources -- :book:  Full documentation for Maestro can be found at [**maestro.mobile.dev**](https://maestro.mobile.dev) -- :speech_balloon:  Public Slack channel: [**Join the workspace**](https://docsend.com/view/3r2sf8fvvcjxvbtk), then head to the `#maestro` channel -- :page_with_curl:  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 + diff --git a/logo.png b/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..dba4117ce5f93ac6430e71314eb119b7190e5df2 GIT binary patch literal 8195 zcmeHMXHZjHyWViHAJou0NKq+*pcJK9AV?SEK>|_)0VPr*LV%FKv0x~IqKMKFX-YBl z8bAm+ih$J6LL~H(L<}U55V+xf^UeMD&D=kC=Fa$I&ziN?p1t1vu6I4pv)(uMs-1=4 zL8*fP00>%MF}nr;0-peYZ)pEs-pG^!|KGgkK+qLvFaR79-hKFhvvPrNB@HTOur@aX0q{o{WXeRs^&E_*1g`qvfEf~RS0?CtG~m6eqPSIJ{z&cPgJX}$YS@l7uv$Zfw9&{`k7O2OCi!C*9^ zdkdQT5_1UT&@efVkJs8$^5SM)(3CIy8DDGoF&8eO4M zaa>ONULYFHBaqfBp6^En3Zo39EJLo@{2j?P-JOyh2p zVqDx&>rM4RxAOUboOIrvpMEIeEgIEe)-g6Q;RgTO*_3(PJo7n z*!#(`v3ot~nVCEOp$LTZo6ldZMh9D+Mr48L0Gx{DIUG)*La!Gsw1;pEuH#s+I2Bo3)PXtaAMKU(hD%$5&QXzHK>o zd`vRMjq+aJT^>-1`03F&N+QAZ^dH2|b-X*1_vfNl|t=~Nabair! zHA;i5v?ItUM3w!%efw{>tlV`a#f$>GHdiPN^)oYOS$w0BO?64y)E-n^Pp6(_)TYU>{3O#LH4vU=i(gjZ* zNW2%%kl=`O>Q}Jw+2oM!S8hsP&^aSHLhiFXQ@Fn^T+X^W_t#7N0Idi23elzzS=OUR zfl2Qih`q7PjL%O}=6(i^{L{W6iE5Ge%I5Qc4)d&wlQTt67)5T3=YKYv*g|pF$!RXN zXbBfe%$8PEIQDxtt%M3TkW!nxk)Rf_y_IB5w{Nru&3Lw0z5Ag<;i4Jc#6$Rx&~Xf^ z2|;&bK<;Ptcom1qubzV{%ViJavJEu7nzAbmXuKHnV^1`MG)k%^BC|CHbomUj1vG%7 znXt!wK4%7fvyHb*^zgP*6&F{k>ZW9cuoSMjf`rgxAAbfu-gM{W*w9Eo6WLiQgJN_W zb5=JYM9vpaEH;}dmCRJs#Ls^!s60>8w)z5x^wVsaqQtE zN05b5oxVZ;U_K=W$-~Hetw;a+bNa7zE&MVj0*IH^Ds4mq6wNY*_Gew2KjE(f!@ zaf%C_KNe|%Vn6L88pdNpk6eGFB8H|{*4Ixg^lfBTVByUSUF_l1#Ye!ODjs~Ty*7k!@& ztKT#+Ffd>b(1^2Lu&q?jTx0O_n@tO$E@;gycI}2pT8#i`z`{%fGUsKj68Ka47jqvGqpFdaK zti%KZtFu$X)ZDk4Nu6wVio>Ht#q4Zm9bu=2BSB~;^-f=XkQ*%RN-(Y=t-DPl_4RAh zGBY!MKq>?Kp5gd&_VOJ9z(*lIv`KDuy?y{3!rt0sJo#+bP3^RuXNDpoWBpU?yb=`F zX1??|G^MFLw7>W9wjXqBB1~;8&mt);jmbKaW^c-^V)!%&DyeWJ2V`3|D5Dds4D+VK zO(?TvY8Cvhwc!51J z&Cp$|Bj{0(jbLm1$r5w^VffAE!_i`a`*Oq}`}uMzFgDu!@0L4_0~X3$8=2fI`Dx?L z@M$o8Az#8DTN7H$&{ctXS92cB_mFy?3%kb?J7Ct63`M0FE3=#N(0;@CpQR|iZuUXZ3#9+J{e=6vHZ5i^4T6W=sq zs-C0e6TKxOCY0u=D@Kc3IP(JWr~R-)fZx$iKu(3kvA=XE3IQkSlhhVTfAcNX(SW9c z+iU$}W3%<{>XJ|gp+UQNBG^Oyz@BPwM~7|H-RFMhPAA`PixEyToSjs#Cklp1^}&VE z>yLAB(^7;&Cfi=6Pk9oO(NY!^;w&8nGb`zz#w~s`+6+9tlKHN>2)$F5M(PR86M(ngOF|5b|xbe zQ8Ju5LWCm&9h%zTOKPIlQV`GkZUBR~K?tCzNK2~w+I^*Q6Ttv1YO{t_>{Zz@=7dsG z_q;uD6_o0EY)v!Y-Z~?Hn9>JtCx^&PJDFdXTrQ5iy!Hfhqufm}i$X-8t+H2~6w97! zYF89@R!dG*+@9h<6N#zI=w7&M)(||<0u}nC)#>s_`mKGadBuV&&P}q>X*^)<8T>*R zCv@9!Ha6-u{p4k%vN||U*U7eSGB3RY1jfD2^)^Y53=Qq9Y~e_x^ZEtU{m*a)RVB{x z76eQNPI`NNeMe2oQa?Z0;cRdA4p!1dAk!d8x9lx$-x0I054kgA8HLItnd|T*{6r(a zt6{&t+be2%npBoict3E#w%{m#&~eIM?SjRQmo1cHXLzMBUykc#we1~(Jb7zd)pP!$ z`)TLl=Zjan>K+su3Jqq64eARn{hFP%pbw7q<_>80er*DU`rZl&sV>f?8>2W>3SW4Z zc_FpNPs`b~qiMleh}|$8y6kd7{T*FLTOMfO2|*jpg3X)F5!5>eq3#)X<>B(><(n9e zwvB9Br;fMsLOi;wGkOe?$}VfR>3f%=`e7*UuDDj{(@z_uYh4u=&);Zev)=BwRhSGl z>6Te#X+UAhGC+p12jA)9y0)8hiy^D-YcOLi6O*AtHFPj3^o+7#e&Kg3vp-& z*^@>XsEaasa-Sy@7#zRS%X@)BUN*wUXEbamj^2o51+>?(J#D)|$Gz|sW8vnM2g8?Fs$xp+isV`Nb@X6v zcs;4nrqU5wM)I63o(xV?9XxNMol>WMyz^Z7I`*${ixu@Lc^wl#%SGIfx2@`D^y0ye-U7mEzY##udX+R%PAcZY|r$ zd7@V%Hc2w8pUCstdSew=rnJ;`Nw9ub*8{CiJi+WCghV23ZFL_>n2Jp01&ZLCku7&) zA~t^3HkV6QWZ6x;Lf{jHK+^0QhlWAqls2dZMf zF+Nf^dAqOn4N{sBK&Bn8=i$D`J)RzTS+p6(`HoQPI^EbvYSRwz3nVRN*$vKabCJz? z=M)82Xf(acW*CVIF~=_~U%8Ne@d&SrG$|#?R97uO2Nmq;vM$_{&c=@Fa}T&xxS!6` zzK^Bm%VyrZzIoz*mT1Xu z%>Pzkh%`xn2Eq^>3a zq6FGnC>vZB(yYlmhSSrE>x64bJ`tsiB?QYY>t~u2QqLvzIm7)AyJ}IZs8oBT`#_?b z3r`Y+MEt6&9fyXh`N|C3D1R+)d1o~gDEPsi>`YGQ7#HXc=PU`$=gcq$5EIkJomj1NG?2Tz(TLj;!aw1&^KlB4 z=jGyEFTX>HAiJsBxcz(REiJ3ey%E@S?lHImxXeadR`v7PJ9w$6{))=7j9_(3i~CxG zL|gEEk={&0MAXl9^GEgxPD{w8n>!}{a!)D;@><4p%h_gsW{Q9M%p(9JsmVZ}a`Y2#X{|8U!zSF0wl#odExd?@d!XdMeMD=0*3CE{_rDO)hlIs%mWX3aiC(-mpBey5K;6R^wHnYav(EL972DRjv~1-CJkIapO*ibON%Illx)STEuWL_pjjSl&Kv+D*x=+N$s;_-wrSJfDZ! z?z-_uMeRvyvX(<8L-!UIPAy^9vnNrk=8O6ie`U<`Yr*fkEd7JxReic1my8f3M8)VK zaeKxat6sbt-k%i~sN3U(VTdooPU)ad6~u>TvJ58UX*af342WI0!qBxoiHp@kG_Q^! zrs|6>zw+4JfxW)|wYSM~#%$L=00{fv`F{9Ns?3HElg87BPKjAcr+2))>N9`4`6mKCBaU2<+p z(!y;}_RS+pdO3?I4er)s0~5I0QyG?!O3O5Fe&=AcDo-k05alIOx@WsmlLEeu_l3Y; z%D+$us5wJgso{*pp%PRbe6`JkpdcekEE--i&8@Q6m>`qow@eg^%znmFJDKAQi5=1E9@O{w?GhVs~02Fj#zw0Ky>qGw`x%az*_PdPuyO#R@ nt)Sd;FD=T=fA?4`6z}|Dc;Hn~%ms;mcKep*c4lRlJRbfRC&y^^ literal 0 HcmV?d00001