Skip to content

Commit

Permalink
docs: update readme (web-infra-dev#161)
Browse files Browse the repository at this point in the history
  • Loading branch information
dexteryy committed Oct 26, 2021
1 parent 5351c95 commit 977f70d
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 10 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,32 @@
<p align="center">
<a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
</p>

<p align="center">
现代 Web 工程体系
<br/>
<a href="https://modernjs.dev" target="blank">
modernjs.dev
</a>
<br/>
<a href="https://modernjs.dev" target="blank">
modernjs.dev
</a>
</p>
<p align="center">
The meta-framework suite designed from scratch for frontend-focused modern web development
</p>

# Introduction

## 参考链接
> The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.
- 介绍 Modern.js (即将上线)
- [迈入现代 Web 开发](https://zhuanlan.zhihu.com/p/386607009)
- [现代 Web 开发者问卷调查报告](https://zhuanlan.zhihu.com/p/403206195)
- [字节跳动是如何落地微前端的](https://mp.weixin.qq.com/s/L9wbfNG5fTXF5bx7dcgj4Q)

## 近期计划
## Getting Started

- [Quick Start](https://modernjs.dev/start)
- [Guides](https://modernjs.dev/guides)
- [API References](https://modernjs.dev/api)

Modern.js 的 1.0.0.rc 版已经发到 npm,目前在做测试改进和文档建设。
## Contributing

README、完整的文档站、介绍等,都计划在 10 月 27 日上线。
- [Contributing Guide](/contributing.md)
13 changes: 12 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
{
"private": true,
"name": "monorepo",
"name": "modern-js-monorepo",
"description": "The meta-framework suite designed from scratch for frontend-focused modern web development.",
"homepage": "https://modernjs.dev",
"bugs": "https://github.com/modern-js-dev/modern.js/issues",
"repository": "modern-js-dev/modern.js",
"license": "MIT",
"keywords": [
"react",
"framework",
"modern",
"modern.js"
],
"scripts": {
"new": "modern new",
"setup": "npm run reset && pnpm install --ignore-scripts",
Expand Down

0 comments on commit 977f70d

Please sign in to comment.