From 77fe8c8463a46fca3715922ffe7f95e6394e367a Mon Sep 17 00:00:00 2001
From: YuCheng Hu <huyuchengus@gmail.com>
Date: Fri, 5 Nov 2021 15:20:57 -0400
Subject: [PATCH] init README.md file

---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 53 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 8982361..035c459 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,53 @@
-# typescript-docs-cn
-Z
+# TypeScript 文档手册
+
+从一个 Java 后端开发的角度来考虑和思考 TypeScript。
+
+## 关于文档
+
+- [在线部署版本](https://typescript.ossez.com/)
+- [GitHub 仓库地址](https://github.com/cwiki-us-docs/typescript-docs-cn)
+- [HoneyMoose](https://github.com/honeymoose)
+- 构建工具 [docsify](https://docsify.js.org/#/) 
+
+本书是作者在学习 [TypeScript] 后整理的学习笔记。
+
+随着对 TypeScript 理解的加深和 TypeScript 社区的发展，本书也会做出相应的更新，欢迎大家 [Star 收藏][GitHub]。
+
+- 发现文章内容有问题，可以直接在页面下方评论
+- 对项目的建议，可以[提交 issue](https://github.com/cwiki-us-docs/typescript-docs-cn) 向作者反馈
+- 欢迎直接提交 pull-request 参与贡献
+
+## 关于 TypeScript
+
+[TypeScript] 是 JavaScript 的一个超集，主要提供了**类型系统**和**对 ES6 的支持**，它由 Microsoft 开发，代码[开源于 GitHub](https://github.com/Microsoft/TypeScript) 上。
+
+它的第一个版本发布于 2012 年 10 月，经历了多次更新后，现在已成为前端社区中不可忽视的力量，不仅在 Microsoft 内部得到广泛运用，而且 Google 开发的 [Angular](https://angular.io/) 从 2.0 开始就使用了 TypeScript 作为开发语言，[Vue](https://vuejs.org/) 3.0 也使用 TypeScript 进行了重构。
+
+## 适合人群
+
+本书适合以下人群
+
+- 熟悉 JavaScript，至少阅读过一遍[《JavaScript 高级程序设计》](https://book.douban.com/subject/10546125/)
+- 了解 ES6，推荐阅读 [ECMAScript 6 入门]
+- 了解 Node.js，会用 npm 安装及使用一些工具
+- 想了解 TypeScript 或者想对 TypeScript 有更深的理解
+
+## 版权许可
+
+本书采用「保持署名—非商用」创意共享 4.0 许可证。
+
+只要保持原作者署名和非商用，您可以自由地阅读、分享、修改本书。
+
+详细的法律条文请参见[创意共享](http://creativecommons.org/licenses/by-nc/4.0/)网站。
+
+## 相关资料
+
+- [TypeScript 官网][TypeScript]
+- [Handbook]（[中文版][中文手册]）
+- [ECMAScript 6 入门]
+
+[GitHub]: https://github.com/xcatliu/typescript-tutorial
+[TypeScript]: http://www.typescriptlang.org/
+[Handbook]: http://www.typescriptlang.org/docs/handbook/basic-types.html
+[中文手册]: https://zhongsp.gitbook.io/typescript-handbook/
+[ECMAScript 6 入门]: http://es6.ruanyifeng.com/
\ No newline at end of file