Skip to content

Commit ac41cf7

Browse files
MeikandaNayanarMeikandaNayanar
committed
Updated the read me file for the UI Kit with license information
1 parent 28ec19a commit ac41cf7

File tree

1 file changed

+107
-2
lines changed

1 file changed

+107
-2
lines changed

‎README.md

Lines changed: 107 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,107 @@
1-
# essential-ui-kit-for-xamarin.forms
2-
This repository contains elegantly designed XAML templates for Xamarin.Forms apps. These templates follow the MVVM design pattern to provide hassle-free integration and are compatible with Android, iOS, and UWP platforms.
1+
# Essential UI Kit for Xamarin.Forms
2+
This repository contains elegantly designed XAML templates for Xamarin.Forms apps. These templates are compatible with Android, iOS, and UWP platforms, and use the MVVM design pattern to provide trouble-free integration.
3+
4+
<p align="center">
5+
<img src="Images/xamarin-forms-ui-template.png" alt="Image"/>
6+
</p>
7+
8+
## Build Status
9+
|CI Tool |Build Status|
10+
|---------------------------|---|
11+
| App Center, iOS | [![Build status](https://build.appcenter.ms/v0.1/apps/ca1f283a-7255-45e4-8cf1-d2ce46cb4a0a/branches/master/badge)](https://appcenter.ms)|
12+
| App Center, Android | [![Build status](https://build.appcenter.ms/v0.1/apps/4e5e10f9-04aa-48ca-ba31-0a58da0c4c4d/branches/master/badge)](https://appcenter.ms) |
13+
14+
## Key Features
15+
* Rich, elegant XAML layouts for most common scenarios.
16+
* Layouts optimized for phones, tablets, and desktop.
17+
* Based on the MVVM design pattern to work with any MVVM framework.
18+
* Easy integration.
19+
* Developer-friendly APIs.
20+
* Appearance customization using styles.
21+
* Optimized layouts to get the best possible performance.
22+
* Right-to-left rendering support.
23+
24+
## Supported Platforms
25+
* Android 5.0 (or API level 21) and later versions.
26+
* iOS 9.0 and later versions.
27+
* UWP Build 17763 and later versions
28+
29+
The required minimum version of Xamarin.Forms is 4.0.0.425677.
30+
31+
## System Requirements
32+
Refer to the [Xamarin system requirements](https://docs.microsoft.com/en-us/xamarin/cross-platform/get-started/requirements) documentation to learn more about the development environments.
33+
34+
## The Visual Studio Extension
35+
The Visual Studio extension allows you to add the required templates quickly through a few clicks. The extension Setup is available in the Visual Studio marketplace with detailed information of how to add the templates.
36+
37+
*VS Item template link*
38+
39+
## Coding Style
40+
We follow the style used by the .NET Foundation, with a few exceptions:
41+
* We use tabs instead of spaces.
42+
* We do not prefix internal and private instance fields with `_`, static fields with `s_` and thread static fields with `t_`.
43+
44+
## Recent Blogs / News
45+
* https://blog.syncfusion.com/post/introducing-ui-templates-for-xamarin-forms.aspx
46+
47+
48+
## Screenshots
49+
<p align="center">
50+
<img src="Images/xamarin-forms-ui-template-login-screens.jpg" alt="Image"/>
51+
</p>
52+
<br/><br/>
53+
54+
<p align="center">
55+
<img src="Images/xamarin-forms-ui-template-article-page.jpg" alt="Image"/>
56+
</p>
57+
<br/><br/>
58+
59+
<p align="center">
60+
<img src="Images/xamarin-forms-ui-template-e-commerce-page.jpg" alt="Image"/>
61+
</p>
62+
<br/><br/>
63+
64+
<p align="center">
65+
<img src="Images/xamarin-forms-ui-template-chat-screen.jpg" alt="Image"/>
66+
</p>
67+
<br/><br/>
68+
69+
<p align="center">
70+
<img src="Images/xamarin-forms-ui-template-feedback-page.jpg" alt="Image"/>
71+
</p>
72+
<br/><br/>
73+
74+
<p align="center">
75+
<img src="Images/xamarin-forms-ui-template-navigation-page.jpg" alt="Image"/>
76+
</p>
77+
<br/><br/>
78+
79+
<p align="center">
80+
<img src="Images/xamarin-forms-ui-template-onboarding-screen.jpg" alt="Image"/>
81+
</p>
82+
<br/><br/>
83+
84+
<p align="center">
85+
<img src="Images/xamarin-forms-ui-template-about-page.jpg" alt="Image"/>
86+
</p>
87+
88+
## Requesting Screens & Reporting Bugs
89+
If you would like to request a new screen or report a bug in existing screens, create a feature request or submit a bug through our [feedback portal](https://www.syncfusion.com/feedback/xamarin-forms).
90+
91+
## License
92+
These are samples/templates. The samples/templates may have various licenses but Syncfusion licenses this as MIT. You may need to obtain additional licenses to use the samples/templates from third parties.
93+
94+
This project uses Syncfusion controls and FFImageLoading (by Daniel Luberda) libraries.
95+
96+
The demo images and illustrations exhibited in this app are obtained from the following website.
97+
98+
https://www.pexels.com/
99+
https://unsplash.com/
100+
https://undraw.co/illustrations
101+
102+
**Note:** This license by no means modifies the license under which 3rd party intellectual property is provided and that such intellectual property is deemed directly licensed from the 3rd party by the user. You are solely responsible for obtaining all 3rd party licenses directly from the provider. These licenses to any third party intellectual property must be independently obtained by Customer from the provider.
103+
104+
## About Syncfusion
105+
Founded in 2001 and headquartered in Research Triangle Park, N.C., Syncfusion has more than 20,000 customers and more than 1 million users, including large financial institutions, Fortune 500 companies, and global IT consultancies.
106+
107+
Today we provide 1,000+ controls and frameworks for web ([ASP.NET Core](https://www.syncfusion.com/aspnet-core-ui-controls), [ASP.NET MVC](https://www.syncfusion.com/aspnet-mvc-ui-controls), [ASP.NET WebForms](https://www.syncfusion.com/jquery/aspnet-web-forms-ui-controls), [JavaScript](https://www.syncfusion.com/javascript-ui-controls), [Angular](https://www.syncfusion.com/angular-ui-components), [React](https://www.syncfusion.com/react-ui-components), [Vue](https://www.syncfusion.com/vue-ui-components), and [Blazor](https://www.syncfusion.com/blazor-components), mobile ([Xamarin](https://www.syncfusion.com/xamarin-ui-controls), [UWP](https://www.syncfusion.com/uwp-ui-controls), and [JavaScript](https://www.syncfusion.com/javascript-ui-controls)), and desktop development ([WinForms](https://www.syncfusion.com/winforms-ui-controls), [WPF](https://www.syncfusion.com/products/wpf-ui-controls), and [UWP](https://www.syncfusion.com/uwp-ui-controls)). We provide ready-to deploy enterprise software for dashboards, reports, data integration, and big data processing. Many customers have saved millions in licensing fees by deploying our software.

0 commit comments

Comments
 (0)