@kdcloudjs/kdesign 1.0.2

package/LICENSE

@@ -0,0 +1,555 @@
+Copyright(C) 2021 Kingdee International Software Group (HK) Ltd. All rights reserved.
+
+KDesign is licensed under the Apache License Version 2.0, except for the third-party components listed below.
+
+A copy of the Apache License Version 2.0 is included in this file.
+
+Other dependencies and licenses:
+
+Open Source Software Licensed Under the MIT License:
+--------------------------------------------------------------------
+ant-design
+Copyright (c) 2015-present Ant UED, https://xtech.antfin.com/
+
+rc-picker
+Copyright (c) 2019-present afc163
+
+daterangepicker
+Copyright (c) 2012-2020 Dan Grossman
+
+rc-form
+Copyright (c) 2014-present yiminghe
+
+rc-slider
+Copyright (c) 2015-present Alipay.com, https://www.alipay.com/
+
+rc-upload
+Copyright (c) 2016-present react-component
+
+@babel/polyfill
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+@babel/runtime
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+@babel/runtime-corejs3
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+@babel/standalone
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+@babel/core
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+@babel/plugin-proposal-class-properties
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+@babel/plugin-proposal-export-namespace-from
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+@babel/plugin-proposal-private-methods
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+@babel/plugin-transform-object-assign
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+@babel/plugin-transform-runtime
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+@babel/preset-env
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+@babel/preset-react
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+@babel/preset-typescript
+Copyright (c) 2014-present Sebastian McKenzie and other contributors
+
+@popperjs/core
+Copyright (c) 2019 Federico Zivolo
+
+async-validator
+Copyright (c) 2014-present yiminghe
+
+axios
+Copyright (c) 2014-present Matt Zabriskie
+
+big.js
+Copyright © <2021> Michael Mclaughlin
+
+classnames
+Copyright (c) 2018 Jed Watson
+
+copy-to-clipboard
+Copyright (c) 2017 sudodoki <smd.deluzion@gmail.com>
+
+date-fns
+Copyright (c) 2021 Sasha Koss and Lesha Koss https://kossnocorp.mit-license.org
+
+lodash
+Copyright JS Foundation and other contributors <https://js.foundation/>
+Based on Underscore.js, copyright Jeremy Ashkenas,
+
+react-draggable
+Copyright (c) 2014-2016 Matt Zabriskie. All rights reserved.
+
+react-popper
+Copyright (c) 2018 React Popper authors
+
+resize-observer-polyfill
+Copyright (c) 2016 Denis Rul
+
+styled-components
+Copyright (c) 2016-present Glen Maddern and Maximilian Stoiber
+
+@commitlint/config-conventional
+Copyright (c) 2016 - present Mario Nebl
+
+@typescript-eslint/eslint-plugin
+Copyright JS Foundation and other contributors, https://js.foundation
+
+
+algoliasearch
+Copyright (c) Algolia support@algolia.com
+
+autoprefixer
+Copyright 2013 Andrey Sitnik <andrey@sitnik.ru>
+
+babel-loader
+Copyright (c) 2014-2019 Luís Couto <hello@luiscouto.pt>
+
+babel-plugin-add-react-displayname
+
+bisheng
+Copyright (c) 2016 Benjy Cui
+
+bisheng-plugin-description
+Copyright (c) 2016 Benjy Cui
+
+bisheng-plugin-toc
+Copyright (c) 2016 Benjy Cui
+
+case-sensitive-paths-webpack-plugin
+Copyright (c) 2018 Michael Pratt
+
+chalk
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+commitlint
+Copyright (c) 2016 - present Mario Nebl
+
+cross-env
+Copyright (c) 2017 Kent C. Dodds
+
+
+css-loader
+Copyright JS Foundation and other contributors
+
+cz-customizable
+Copyright (c) 2016 Leonardo Correa
+
+dekko
+Copyright (c) 2016 Benjy Cui
+
+enzyme
+Copyright (c) 2015 Airbnb, Inc. and contributors
+
+enzyme-adapter-react-16
+Copyright (c) 2015 Airbnb, Inc. and contributors
+
+enzyme-to-json
+Copyright (c) 2016 Adrien Antoine adriantoine@gmail.com
+
+eslint
+Copyright OpenJS Foundation and other contributors, <www.openjsf.org>
+
+eslint-config-prettier
+Copyright (c) 2017, 2018, 2019, 2020, 2021 Simon Lydell and contributors
+
+eslint-plugin-babel
+Copyright (c) 2014-2015 Jason Quense <jason@quense.me>
+
+esbuild-webpack-plugin
+
+eslint-plugin-import
+opyright (c) 2015 Ben Mosher
+
+eslint-plugin-jest
+Copyright (c) 2018 Jonathan Kim
+
+eslint-plugin-jsx-a11y
+The MIT License (MIT) Copyright (c) 2016 Ethan Cohen
+
+eslint-plugin-markdown
+opyright JS Foundation and other contributors, https://js.foundation
+
+eslint-plugin-node
+Copyright (c) 2015 Toru Nagashima
+
+eslint-plugin-prettier
+opyright © 2017 Andres Suarez and Teddy Katz
+
+eslint-plugin-react
+Copyright (c) 2014 Yannick Croissant
+
+eslint-plugin-react-hooks
+Copyright (c) Facebook, Inc. and its affiliates.
+
+file-loader
+Copyright JS Foundation and other contributors
+
+gulp
+Copyright (c) 2013-2018 Blaine Bublitz <blaine.bublitz@gmail.com>, Eric Schoffstall <yo@contra.io> and other contributors
+
+gulp-babel
+Copyright © 2014-2018 Sindre Sorhus sindresorhus@gmail.com (sindresorhus.com)
+
+gulp-strip-code
+Copyright (c) 2014 Massimiliano Zoffoli
+
+gulp-typescript
+Copyright (c) 2020 Ivo Gabe de Wolff
+
+husky
+Copyright (c) 2021 typicode
+
+identity-obj-proxy
+Copyright (c) 2015 Keyan Zhang
+
+intersection-observer
+All Reports in this Repository are licensed by Contributors under the W3C Software and Document License. Contributions to Specifications are made under the W3C CLA.
+
+jest
+Copyright (c) Facebook, Inc. and its affiliates.
+
+jest-environment-enzyme
+Copyright (c) 2016 Blaine Kasten
+
+jest-enzyme
+Copyright (c) 2016 Blaine Kasten
+
+jest-stare
+Copyright (c) 2018
+
+jsonml.js
+https://www.npmjs.com/~benjycui
+
+less-loader
+Copyright JS Foundation and other contributors
+
+less-vars-to-js
+https://github.com/michaeltaranto
+
+lint-staged
+Copyright (c) 2016 Andrey Okonetchnikov
+
+merge2
+Copyright (c) 2014-2020 Teambition
+
+mini-css-extract-plugin
+Copyright JS Foundation and other contributors
+
+mockdate
+opyright (c) 2014 Bob Lauer
+
+mq-polyfill
+Copyright © 2016 Pavel Tereschenko
+
+node-fetch
+opyright (c) 2016 - 2020 Node Fetch Team
+
+np
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+
+scrollama
+Copyright (c) 2017 Russell Goldenberg
+
+simple-git
+Copyright (c) 2015 Steve King
+
+
+post-loader
+Copyright (c) egoist <0x142857@gmail.com> (https://egoistian.com)
+
+postcss
+Copyright 2013 Andrey Sitnik <andrey@sitnik.ru>
+
+postcss-pxtorem
+Copyright (C) 2014 Jonathan Cuthbert <jon@cuth.net>
+
+prettier
+Copyright © James Long and contributors
+
+react
+Copyright (c) Facebook, Inc. and its affiliates.
+
+react-live
+Copyright (c) 2013
+
+optimize-css-assets-webpack-plugin
+Copyright (c) 2016 Nuno Rodrigues
+
+stylelint
+Copyright (c) 2015 - present Maxime Thirouin, David Clark & Richard Hallows
+
+stylelint-config-prettier
+Copyright (c) Shannon Moeller <me@shannonmoeller.com> (shannonmoeller.com)
+Copyright (c) Hugo Dias <mail@hugodias.me> (https://hugodias.me)
+Copyright (c) 2017 Simon Lydell
+
+stylelint-config-standard
+Copyright (c) 2015 - present stylelint authors
+
+stylelint-declaration-block-no-ignored-properties
+Copyright (c) 2018 Krister Kari
+
+through2
+Copyright (c) Rod Vagg (the "Original Author") and additional contributors
+
+ts-jest
+copyright (c) 2016-2018
+
+uglifyjs-webpack-plugin
+Copyright JS Foundation and other contributors
+
+url-loader
+Copyright JS Foundation and other contributors
+
+webpack-bundle-analyzer
+Copyright JS Foundation and other contributors
+
+webpack-cli
+Copyright JS Foundation and other contributors
+
+webpack-dev-server
+Copyright JS Foundation and other contributors
+
+webpack-filter-warnings-plugin
+Copyright (c) 2017 Matt Lewis
+
+webpack-merge
+Copyright (c) 2015 Juho Vepsalainen
+
+webpackbar
+Copyright JS Foundation and other contributors
+
+react-dom
+Copyright (c) Facebook, Inc. and its affiliates.
+
+Terms of the MIT License:
+---------------------------------------------------
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
+
+
+Open Source Software Licensed Under the BSD-2-Clause License: 
+--------------------------------------------------------------------
+@typescript-eslint/parser
+Copyright JS Foundation and other contributors, https://js.foundation
+
+nunjucks
+Copyright (c) 2012-2015, James Long
+
+omit.js
+opyright (c) 2016 Benjy Cui
+
+Terms of the BSD-2-Clause License:
+---------------------------------------------------
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Open Source Software Licensed Under the BSD-3-Clause License: 
+--------------------------------------------------------------------
+eslint-config-prettier-standard
+Copyright (c) 2017, Nick Petruzzelli
+
+Terms of the BSD-3-Clause License:
+---------------------------------------------------
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+Open Source Software Licensed Under the ISC License: 
+--------------------------------------------------------------------
+conventional-changelog-cli
+Copyright © conventional-changelog team
+
+eslint-plugin-promise
+Copyright (c) 2020, Jamund Ferguson
+
+rimraf
+Copyright (c) Isaac Z. Schlueter and Contributors
+
+standard-version
+Copyright (c) 2016, Contributors
+
+Terms of the ISC License:
+---------------------------------------------------
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+Open Source Software Licensed Under the Apache-2.0 License License: 
+--------------------------------------------------------------------
+jest-image-snapshot
+ https://americanexpress.io
+
+less
+https://github.com/less
+
+less-plugin-npm-import
+https://github.com/less
+
+typescript
+https://github.com/microsoft/TypeScript
+
+terms of the Apache License Version 2.0:
+--------------------------------------------------------------------
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that
+entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity,
+whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that
+is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial
+revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License,
+Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative
+Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal,
+or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source
+code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the
+Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell,
+sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are
+necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You
+under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications,
+and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from
+the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy
+of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
+at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation,
+if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally
+appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices
+within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution
+notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction,
+or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise
+complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to
+the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing
+herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as
+required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including
+any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability
+to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other
+commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to
+indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,91 @@
+# KDesign of React
+
+KDesign of React 是基于金蝶的企业级设计系统KDesign 实现的一套React UI组件库，主要用于企业级系统的构建。
+
+
+## 特性
+- 提供开箱即用的 丰富的企业级 React UI 组件。
+- 使用 TypeScript 开发，提供完整的类型定义文件。
+- 组件全键盘的支持
+- 国际化支持
+- 全面的主题化定制
+
+## 安装
+
+### 使用 npm 或 yarn 安装
+
+```bash
+$ npm install @kdcloudjs/kdesign --save
+# 或者
+$ yarn add @kdcloudjs/kdesign
+```
+
+### 示例
+```js
+import React from 'react'
+import reactDom from 'react-dom'
+import { Button } from '@kdcloudjs/kdesign'
+import '@kdcloudjs/kdesign/dist/kdesign.css'
+
+reactDom.render((
+  <div>
+    <Button>kdesign 按钮</Button>
+  </div>
+), document.getElementById('root'))
+```
+
+### 浏览器引入
+
+在浏览器中使用 `script` 和 `link` 标签直接引入文件，并使用全局变量 `kdesign`。
+目前尚未将文件上传至 `cdn` 需要手动将 `dist` 目录下的 `kdesign.min.js` 和 `kdesign.min.css` 文件拷贝至项目。
+
+使用：
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>kdesign</title>
+  <script src="https://cdn.staticfile.org/react/16.14.0/umd/react.development.js"></script>
+  <script src="https://cdn.staticfile.org/react-dom/16.14.0/umd/react-dom.development.js"></script>
+  <script src="https://cdn.staticfile.org/babel-standalone/6.26.0/babel.min.js"></script>
+
+  <script src="https://unpkg.com/@kdcloudjs/kdesign@latest/dist/kdesign.min.js"></script>
+  <link rel="stylesheet" href="https://unpkg.com/@kdcloudjs/kdesign@latest/dist/kdesign.min.css">
+</head>
+<body>
+<div id="root"></div>
+<script type="text/babel">
+  ReactDOM.render((
+      <div>
+        <kdesign.Button>kdesign 按钮</kdesign.Button>
+      </div>
+    ),
+    document.getElementById('root')
+  )
+</script>
+</body>
+</html>
+```
+
+## 相关链接
+- [首页](https://react.kingdee.design/)
+- [介绍](https://react.kingdee.design/docs/guide/introduce)
+- [在 create-react-app 中使用](https://react.kingdee.design/docs/guide/create-react-app)
+- [在 TypeScript 中使用](https://react.kingdee.design/docs/guide/typescript)
+- [ConfigProvider 全局化配置](https://react.kingdee.design/docs/guide/config)
+- [自定义主题](https://react.kingdee.design/docs/guide/customtopic)
+- [国际化](https://react.kingdee.design/docs/guide/locale)
+- [更新日志](https://react.kingdee.design/docs/guide/changelog)
+
+## 浏览器兼容性
+
+| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari-ios/safari-ios_48x48.png" alt="iOS Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>iOS Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/samsung-internet/samsung-internet_48x48.png" alt="Samsung" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Samsung | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Opera |
+| --------- | --------- | --------- | --------- | --------- | --------- | --------- |
+| IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions
+
+## 参与贡献
+参与贡献前请先阅读 [贡献指南](./CONTRIBUTING.md)
+
+## License
+kdesign 使用了 Apache License, Version 2.0. 详细license 请查看 [LICENSE](./LICENSE)