Update README.md
This commit is contained in:
Родитель
8ccfc34729
Коммит
ac46bfa011
77
README.md
77
README.md
|
@ -1 +1,76 @@
|
|||
# FormsCommunityToolkit
|
||||
Forms Community Toolkit
|
||||
===========
|
||||
|
||||
The Forms Community Toolkit is a collection of helper functions, custom controls, and app services. It simplifies and demonstrates common developer tasks building iOS, Android, and UWP apps with Xamarin.Forms
|
||||
|
||||
## Build status
|
||||
|
||||
| Target | Branch | Status | Recommended Nuget packages version |
|
||||
| ------ | ------ | ------ | ------ |
|
||||
| Animations | master | [![Build status](https://ci.appveyor.com/api/projects/status/mo63rolpvxh8frbr/branch/master?svg=true)](https://ci.appveyor.com/project/FormsCommunityToolkit/animations/branch/master) | [![NuGet](https://img.shields.io/nuget/v/Xam.Plugin.Media.svg?label=NuGet)](https://www.nuget.org/packages/FormsCommunityToolkit.Animations/) |
|
||||
| Animations | dev | [![Build status](https://ci.appveyor.com/api/projects/status/mo63rolpvxh8frbr/branch/dev?svg=true)](https://ci.appveyor.com/project/FormsCommunityToolkit/animations/branch/dev) | |
|
||||
| Behaviors | master | [![Build status](https://ci.appveyor.com/api/projects/status/7biielmyt0u7assc/branch/master?svg=true)](https://ci.appveyor.com/project/FormsCommunityToolkit/behaviors/branch/master) | [![NuGet](https://img.shields.io/nuget/v/Xam.Plugin.Media.svg?label=NuGet)](https://www.nuget.org/packages/FormsCommunityToolkit.Behaviors/) |
|
||||
| Behaviors | dev | [![Build status](https://ci.appveyor.com/api/projects/status/7biielmyt0u7assc/branch/dev?svg=true)](https://ci.appveyor.com/project/FormsCommunityToolkit/behaviors/branch/dev) | |
|
||||
| Controls | master | [![Build status](https://ci.appveyor.com/api/projects/status/4vfyejrlgi6a6p3n/branch/master?svg=true)](https://ci.appveyor.com/project/FormsCommunityToolkit/controls/branch/master) | [![NuGet](https://img.shields.io/nuget/v/Xam.Plugin.Media.svg?label=NuGet)](https://www.nuget.org/packages/FormsCommunityToolkit.Controls/) |
|
||||
| Controls | dev | [![Build status](https://ci.appveyor.com/api/projects/status/4vfyejrlgi6a6p3n/branch/dev?svg=true)](https://ci.appveyor.com/project/FormsCommunityToolkit/controls/branch/dev) | |
|
||||
| Converters | master | [![Build status](https://ci.appveyor.com/api/projects/status/a2a4mah2fk8xicm7/branch/master?svg=true)](https://ci.appveyor.com/project/FormsCommunityToolkit/converters/branch/master) | [![NuGet](https://img.shields.io/nuget/v/Xam.Plugin.Media.svg?label=NuGet)](https://www.nuget.org/packages/FormsCommunityToolkit.Converters/) |
|
||||
| Converters | dev | [![Build status](https://ci.appveyor.com/api/projects/status/a2a4mah2fk8xicm7/branch/dev?svg=true)](https://ci.appveyor.com/project/FormsCommunityToolkit/converters/branch/master) | |
|
||||
| Effects | master | [![Build status](https://ci.appveyor.com/api/projects/status/0k37svpmjx8l6ctg/branch/master?svg=true)](https://ci.appveyor.com/project/FormsCommunityToolkit/effects/branch/master) | [![NuGet](https://img.shields.io/nuget/v/Xam.Plugin.Media.svg?label=NuGet)](https://www.nuget.org/packages/FormsCommunityToolkit.Effects/) |
|
||||
| Effects | dev | [![Build status](https://ci.appveyor.com/api/projects/status/0k37svpmjx8l6ctg/branch/dev?svg=true)](https://ci.appveyor.com/project/FormsCommunityToolkit/effects/branch/dev) | |
|
||||
| Gestures | master | [![Build status](https://ci.appveyor.com/api/projects/status/yjymobl63rs8qfau/branch/master?svg=true)](https://ci.appveyor.com/project/FormsCommunityToolkit/gestures/branch/master) | [![NuGet](https://img.shields.io/nuget/v/Xam.Plugin.Media.svg?label=NuGet)](https://www.nuget.org/packages/FormsCommunityToolkit.Gestures/) |
|
||||
| Gestures | dev | [![Build status](https://ci.appveyor.com/api/projects/status/yjymobl63rs8qfau/branch/dev?svg=true)](https://ci.appveyor.com/project/FormsCommunityToolkit/gestures/branch/dev) | |
|
||||
|
||||
## Contributing
|
||||
Do you want to contribute? Here are our [contribution guidelines](https://github.com/FormsCommunityToolkit/FormsCommunityToolkit/blob/master/contributing.md).
|
||||
|
||||
## Getting started
|
||||
|
||||
Coming Soon.
|
||||
|
||||
## Forms Community Toolkit Sample App
|
||||
|
||||
Want to see the toolkit in action before jumping into the code? Download and play with the [Forms Toolkit Sample App]().
|
||||
|
||||
## Nuget Packages
|
||||
|
||||
NuGet is a standard package manager for .NET applications that is built into Visual Studio. From your open solution choose the *Tools* menu, *NuGet Package Manager*, *Manage NuGet packages for solution...* to open the UI. Enter one of the package names below to search for it online.
|
||||
|
||||
Once you search you should see a list similar to the one below (versions may be different, but names should be the same).
|
||||
|
||||
| NuGet Package Name | description |
|
||||
| --- | --- |
|
||||
| FormsCommunityToolkit.Animations | |
|
||||
| FormsCommunityToolkit.Behaviors | |
|
||||
| FormsCommunityToolkit.Controls | |
|
||||
| FormsCommunityToolkit.Converters | |
|
||||
| FormsCommunityToolkit.Effects | |
|
||||
| FormsCommunityToolkit.Gestures | |
|
||||
|
||||
## Features
|
||||
|
||||
### Animations
|
||||
|
||||
### Behaviors
|
||||
|
||||
### Controls
|
||||
|
||||
### Converters
|
||||
|
||||
### Effects
|
||||
|
||||
### Gestures
|
||||
|
||||
## Feedback and Requests
|
||||
|
||||
Please use [GitHub issues](https://github.com/FormsCommunityToolkit/FormsCommunityToolkit/issues) for questions, comments, feature requests, or if would like to vote on what others are recommending.
|
||||
|
||||
## Principles
|
||||
|
||||
- Principle #1: The toolkit will be kept simple.
|
||||
- Principle #2: As soon as a comparable feature is available in the Windows SDK for Windows 10, it will be marked as deprecated.
|
||||
- Principle #3: All features will be supported for two Windows SDK for Windows 10 release cycles or until another principle supersedes it.
|
||||
|
||||
This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/)
|
||||
to clarify expected behavior in our community.
|
||||
For more information see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).
|
||||
|
||||
|
|
Загрузка…
Ссылка в новой задаче