Skip to content

Commit 46f8202

Browse files
authored
Update README.md
1 parent b8d7181 commit 46f8202

File tree

1 file changed

+70
-17
lines changed

1 file changed

+70
-17
lines changed

Diff for: README.md

+70-17
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,72 @@
22

33
# Legerity for Uno Platform
44

5-
Built on top of the [Legerity UI testing framework](https://github.com/MADE-Apps/legerity), this library is to be used with Android, iOS, and Web applications built with the Uno Platform (www.platform.uno) rendered cross-platform elements.
5+
<div style="margin-bottom:16px;">
6+
<div>
7+
<div><span>/<span>ləˈdʒɛr ɪ ti</span>/ (l<i>uh</i>-<b>jer</b>-i-tee)</span></div>
8+
</div>
9+
<div>
10+
<div>
11+
<div>
12+
<div><i><span>noun</span></i></div>
13+
</div>
14+
</div>
15+
<ol>
16+
<li>
17+
<div style="margin-left:20px">
18+
<div class="LTKOO sY7ric">
19+
<div style="display:inline" data-dobid="dfn"><span>physical or mental quickness; nimbleness;
20+
agility.</span></div>
21+
</div>
22+
</div>
23+
</li>
24+
</ol>
25+
</div>
26+
</div>
27+
28+
[![GitHub release](https://img.shields.io/github/release/MADE-Apps/legerity-uno.svg)](https://github.com/MADE-Apps/legerity-uno/releases)
29+
[![Nuget](https://img.shields.io/nuget/v/Legerity.Uno.svg)](https://www.nuget.org/packages/Legerity.Uno/)
30+
[![Nuget Preview](https://img.shields.io/nuget/vpre/Legerity.Uno.svg?label=nuget%20%28preview%29)](https://www.nuget.org/packages/Legerity.Uno/)
31+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Legerity.Uno.svg)](https://www.nuget.org/packages/Legerity.Uno)
32+
[![Build status](https://github.com/MADE-Apps/legerity-uno/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/MADE-Apps/legerity-uno/actions/workflows/ci.yml)
33+
[![Legerity docs](https://img.shields.io/badge/docs-Legerity%20Uno-blue.svg)](https://made-apps.github.io/legerity-uno/)
34+
[![Legerity discussions](https://img.shields.io/badge/discuss-Legerity%20Uno-blue.svg)](https://github.com/MADE-Apps/legerity-uno/discussions)
35+
36+
Legerity for Uno Platform is a cross-platform automated UI testing framework for building maintainable, write once, run everywhere tests quickly for [Uno Platform applications](https://www.platform.uno) with .NET.
37+
38+
It simplifies the development by providing easy-to-use element wrappers for Uno Platform app controls that allow developers to quickly get up and running with UI tests in no time.
39+
40+
Legerity also provides a best practice page object pattern for building UI tests with a maintainable structure. Together with app control wrappers, Legerity for Uno Platform provides the best experience for building maintainable UI automation with speed for Uno Platform apps.
41+
42+
**[Discover what's new in Legerity for Uno Platform](https://github.com/MADE-Apps/legerity-uno/releases)**
43+
44+
## Features ⭐
45+
46+
- **UnoAppManager** - A wrapper around the [Selenium WebDriver](https://github.com/SeleniumHQ/selenium) and [Appium WebDrivers](https://github.com/appium/appium-dotnet-driver) to simplify starting your UI tests. Supports running a single set of UI tests across multiple platforms, or browsers.
47+
- **Page Object Pattern** - Provides a `BasePage` that can be used to create page objects associated with pages in your application that are easy to implement and maintain.
48+
- **[Page Object Generator](tools/Legerity.Uno.PageObjectGenerator)** - A dotnet CLI tool that will automatically create page objects by understanding your Uno Platform page files!
49+
- **Element Wrappers** - Contains a collection of out-of-the-box wrappers for Uno Platform UI elements across all platforms that are easy to use with interactions.
50+
- **Testing Frameworks** - Legerity for Uno Platform is agnostic of .NET testing frameworks (e.g. NUnit, xUnit, MSTest, etc.) so you can work with what you know.
51+
- **CI** - Legerity for Uno Platform is also agnostic of host CI runner platforms (e.g. GitHub Actions, Azure Pipelines, etc.) and can be run anywhere.
52+
- **Extendable** - `UnoElementWrapper` provides everything you need to build out element wrappers for your own Uno Platform controls.
653

7-
Legerity for Uno Platform provides the best experience for building maintainable UI automation with speed for Uno Platform applications.
8-
9-
## Support Legerity for Uno Platform♥
10-
11-
As many developers know, projects like Legerity for Uno Platform are built and maintained in spare time. If you find this project useful, please **Star** the repo and if possible, sponsor the project development on GitHub.
54+
## Documentation 📃
1255

13-
## Build Status
56+
If you want to deep dive into the Legerity for Uno Platform framework with details on how to use the features, you can browse the [documentation](https://made-apps.github.io/legerity-uno/) for help getting up and running!
1457

15-
| Build | Status | Current Version |
16-
| ------ | ------ | ------ |
17-
| Packages | [![CI](https://github.com/MADE-Apps/legerity-uno/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/MADE-Apps/legerity-uno/actions/workflows/ci.yml) | [![Nuget](https://img.shields.io/nuget/v/Legerity.Uno.svg)](https://www.nuget.org/packages/Legerity.Uno/) |
18-
| Docs | [![Docs](https://github.com/MADE-Apps/legerity-uno/actions/workflows/docs.yml/badge.svg?branch=main)](https://github.com/MADE-Apps/legerity-uno/actions/workflows/docs.yml) | N/A |
19-
| [Page Object Generator](tools/Legerity.Uno.PageObjectGenerator) | [![CI](https://github.com/MADE-Apps/legerity-uno/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/MADE-Apps/legerity-uno/actions/workflows/ci.yml) | [![Nuget](https://img.shields.io/nuget/v/Legerity.Uno.PageObjectGenerator.svg)](https://www.nuget.org/packages/Legerity.Uno.PageObjectGenerator/) |
58+
Our documentation includes usages examples, as well as API documentation for your technical reference.
2059

2160
## Installation 💾
2261

2362
Legerity for Uno Platform is publicly available via NuGet. Each available package is detailed below.
2463

25-
| Package | Current | Preview |
26-
| ------ | ------ | ------ |
27-
| Legerity.Uno | [![Nuget](https://img.shields.io/nuget/v/Legerity.Uno.svg)](https://www.nuget.org/packages/Legerity.Uno/) | [![Nuget](https://img.shields.io/nuget/vpre/Legerity.Uno.svg)](https://www.nuget.org/packages/Legerity.Uno/) |
64+
| Package | Downloads |
65+
| ------ | ------ |
66+
| [![Nuget](https://img.shields.io/nuget/v/Legerity.Uno.svg?label=Legerity+Uno)](https://www.nuget.org/packages/Legerity.Uno/) | [![NuGet Downloads](https://img.shields.io/nuget/dt/Legerity.Uno.svg)](https://www.nuget.org/packages/Legerity.Uno) |
2867

29-
## Documentation 📃
68+
## Support Legerity for Uno Platform 💗
3069

31-
If you want to deep dive into the Legerity for Uno Platform library with details on how to use the features, you can browse the [documentation](https://made-apps.github.io/legerity-uno/) for help getting up and running!
70+
As many developers know, projects like Legerity for Uno Platform are built and maintained in spare time. If you find this project useful, please **Star** the repo and if possible, sponsor the project development on GitHub.
3271

3372
## Contributing 🚀
3473

@@ -43,6 +82,20 @@ You can build the solution using Visual Studio with the following workloads inst
4382
- .NET desktop development
4483
- .NET Core cross-platform development
4584

85+
## Got components? 💭
86+
87+
Do you have a collection of custom components that you'd like to see added to the Legerity for Uno Platform framework? Feel free to drop a feature request into our [work tracker](https://github.com/MADE-Apps/legerity-uno/issues)!
88+
89+
Even better, why not help build out your custom control wrapper elements within the framework and help out the community!
90+
91+
### UI Automation tooling 🧰
92+
93+
When contributing to new element wrappers, we recommended using the [Accessibility Insights tool](https://accessibilityinsights.io/en/). The tool is capable of inspecting and providing property values for Android, Web, and Windows applications.
94+
95+
Alternatively, you can use the [Inspect.exe tool](https://docs.microsoft.com/en-us/windows/win32/winauto/inspect-objects) for Windows applications installed with the Windows SDKs. This is not recommended as the tool is considered legacy and can often cause oddities in UI when using.
96+
97+
For your Uno Platform web application, you can also use F12 developer tools to inspect your application layout tree.
98+
4699
## License
47100

48101
Legerity for Uno Platform is made available under the terms and conditions of the [MIT license](LICENSE).

0 commit comments

Comments
 (0)