From 872e0f90bd55643a0c2e38d4767df54d5156acb3 Mon Sep 17 00:00:00 2001 From: enisn Date: Fri, 8 Feb 2019 15:13:36 +0300 Subject: [PATCH] Documentation & Nuspec File Update --- GettingStarted.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++ InputKit.nuspec | 19 +++++++++++----- README.md | 34 +++++++--------------------- 3 files changed, 78 insertions(+), 31 deletions(-) create mode 100644 GettingStarted.md diff --git a/GettingStarted.md b/GettingStarted.md new file mode 100644 index 0000000..faf7591 --- /dev/null +++ b/GettingStarted.md @@ -0,0 +1,56 @@ +# Getting Started with InputKit +Importing and using **InputKit** is easy as possible. It's plug & play logic. Just add to your project and use it. +> No more Init(); methods for your each platform ! + +
+ +# Adding to your project +This plugin published on [NuGet](https://www.nuget.org/) to much more quicker implementation. This instructions uses nuget option. + +- **Right Click** to your solution and go **Manage NuGet Packages**. +- Type to searchbar **Xamarin.Forms.InputKit** and find that package. +- Choose all platforms you want to use and click the **Install** button. + +### Android +If you use it on Android platform there is just one more step. + +- **Right Click** to your solution and go **Manage NuGet Packages**. +- Find and Install [Plugin.CurrentActivity](https://github.com/jamesmontemagno/CurrentActivityPlugin) from NuGet to your only Android Project! +- Add following code to **OnCreate** method of your **MainActivity** in Android Project. +```csharp +//... +base.OnCreate(savedInstanceState); +CrossCurrentActivity.Current.Init(this, savedInstanceState); // < ---- Add here +LoadApplication(new App()); +//... +``` + +#### Why Do That on Android ? +Controls in InputKit uses current android activity to make some actions like open dropdown menu, changing color of icons,... etc. + +
+ +### iOS +Nothing more. Just Plug & Play! + +
+ +### UWP +This platform is Experimental. Some of features may not work! +It's not recommended to release your projects with InputKit on UWP platform. + +But if want a try. No more code needed on UWP too. + +
+ +# Using at your Project + - Go to your XAML page and add following xml namespace to your **ContentPage** tag as like [this sample](https://github.com/enisn/Xamarin.Forms.InputKit/blob/f9aba6b7ce104c1466b521a59830d69956e5cc54/Sample.InputKit/Sample.InputKit/MainPage.xaml#L5) +```csharp +xmlns:input="clr-namespace:Plugin.InputKit.Shared.Controls;assembly=Plugin.InputKit" +``` +*[See how it should be done at sample](https://github.com/enisn/Xamarin.Forms.InputKit/blob/f9aba6b7ce104c1466b521a59830d69956e5cc54/Sample.InputKit/Sample.InputKit/MainPage.xaml#L5)* + +- Then use it at wherever you want in your page with defined prefix `input` like following code: +```csharp + +``` \ No newline at end of file diff --git a/InputKit.nuspec b/InputKit.nuspec index d93e3cb..79cf4ee 100644 --- a/InputKit.nuspec +++ b/InputKit.nuspec @@ -5,7 +5,7 @@ Xamarin.Forms.InputKit - 2.3.6.1 + 2.3.6.2 enisn @@ -36,8 +36,8 @@ ... This package includes awesome controls to get inputs easily from users and make validation easier. - Just import NuGet package to your project and use it! - + Just import NuGet package to your project and use it! + There is no any Init() methods for your each platform! @@ -50,8 +50,17 @@ - - + + + + + + + + + + + diff --git a/README.md b/README.md index 7a64abc..384e0a5 100644 --- a/README.md +++ b/README.md @@ -9,41 +9,16 @@ - -
[![Build status](https://ci.appveyor.com/api/projects/status/st6lcbts9bkhxqub?svg=true)](https://ci.appveyor.com/project/enisn/xamarin-forms-inputkit) [![CodeFactor](https://www.codefactor.io/repository/github/enisn/xamarin.forms.inputkit/badge)](https://www.codefactor.io/repository/github/enisn/xamarin.forms.inputkit) -
-

- -## You can offer new controls! -You can contribute and type your feedbacks about new controls and featues from [here](https://github.com/enisn/Xamarin.Forms.InputKit/issues/45). - -

-### Also You may interested in: - - - - - - - -
- - - - - -
- ## Available Platforms @@ -52,13 +27,19 @@ You can contribute and type your feedbacks about new controls and featues from [ | --- | --- | --- | | Android | MonoAndroid80 | YES | | iOS | Xamarin.iOS10 | YES | -| UWP | - | YES * | +| UWP | - | **EXPERIMENTAL** | | MAC | Xamarin.Mac20 | YES | | WatchOS | Xamarin.WatchOS10 | YES | | .NET Standard | 2.0 | YES | | .NET Standard | 1.0 | **NO** | +
+ +## Getting Started with InputKit + +There is no complicated steps for set-up, no Inits no implementation codes. Plug & Play. +Read [Documentation of Getting Started](https://github.com/enisn/Xamarin.Forms.InputKit/wiki/Getting-Started).
@@ -67,6 +48,7 @@ You can contribute and type your feedbacks about new controls and featues from [

As you know ther is no CheckBox in Xamarin Forms Library. You can use a custom renderer to use Native Checkbox in portable layer. This CheckBox is not a native one, It's created in Xamarin Forms Portable layer.

+

Also you can read more about Checkbox from here

SAMPLE:

```xaml