docs: update readme and optimize content (#6)

* docs: review and update content, initial

* docs: manually remove extra content in customization

* docs: optimize content and shorten intros

* docs: generate customization
This commit is contained in:
Desislava Mihaylova 2017-09-07 10:56:51 +03:00 коммит произвёл GitHub
Родитель 1458a15963
Коммит 8288134e56
4 изменённых файлов: 38 добавлений и 13 удалений

2
CODEOWNERS.md Normal file
Просмотреть файл

@ -0,0 +1,2 @@
* @gyoshev @joneff
docs/* @dmihaylo

12
LICENSE.md Normal file
Просмотреть файл

@ -0,0 +1,12 @@
This package is part of the following suites:
* [Kendo UI for Angular](http://www.telerik.com/kendo-angular-ui/)
* [Kendo UI for jQuery](http://www.telerik.com/kendo-ui)
* [UI for ASP.NET MVC](http://www.telerik.com/aspnet-mvc)
* [UI for ASP.NET Core](http://www.telerik.com/aspnet-core-ui)
All available Kendo UI commercial licenses may be obtained at http://www.telerik.com/purchase/kendo-ui.
If you do not own a commercial license, the usage of this software shall be governed by the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
*Copyright © 2017 Telerik AD. All rights reserved.*

Просмотреть файл

@ -1,20 +1,31 @@
# Kendo UI Material Theme -- PREVIEW, subject to breaking changes without notice
# Kendo UI Material Theme
* [Overview](#overview)
* [Installation](#installation)
> The Kendo UI Material theme is in a preview stage. The current setup is subject to breaking changes without prior notice.
## Overview
The Kendo UI Material Theme is a SCSS-based theme for the Kendo UI components which is based on the [Material design guidelines](https://material.io/).
The **Kendo UI Material Theme** is a theme for the Kendo UI components, based on the [Material design guidelines](https://material.io/).
* [License](#license)
* [Basic Usage](#basic-usage)
The Material theme is available for the following suites:
## License
* Kendo UI for React.
* Kendo UI for Angular.
* Kendo UI for jQuery.
This package is part of the following suites:
## Installation
* [Kendo UI for Angular](http://www.telerik.com/kendo-angular-ui/)
* [Kendo UI for jQuery](http://www.telerik.com/kendo-ui)
* [UI for ASP.NET MVC](http://www.telerik.com/aspnet-mvc)
* [UI for ASP.NET Core](http://www.telerik.com/aspnet-core-ui)
1. Run the `npm install` command to install the build dependencies.
1. Run the `npm run build` command to build the CSS.
All available Kendo UI commercial licenses may be obtained at http://www.telerik.com/purchase/kendo-ui.
If you do not own a commercial license, the usage of this software shall be governed by the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
*Copyright © 2017 Telerik AD. All rights reserved.*
## Basic Usage
For more information on how to implement the Material theme in your project, refer to the following articles:
* [Using the Material Theme in Angular Projects](http://www.telerik.com/kendo-angular-ui/components/styling/)
* [Using the Material Theme in jQuery Projects](http://docs.telerik.com/kendo-ui/styles-and-layout/sass-themes)
* [Customizing the Material Theme](https://github.com/telerik/kendo-theme-default/blob/13713a572b392806ca7c2950f77f9b033f87d8ea/README.md)

Просмотреть файл

@ -7,7 +7,7 @@ position: 1
# Preview
The following application demonstrates how the Kendo UI components for Angular look like when styled with the Kendo UI Material theme for Angular.
The following example previews Kendo UI components for Angular styled with the Material theme.
{% theme_preview theme:material %}
<script async src="{% asset_path theme-preview.js %}"></script>