feat: add new features

CHANGELOG.md

@@ -0,0 +1,14 @@
+## 0.0.1 (2021-02-20)
+
+
+### Bug Fixes
+
+* modify the licence to Apache-2.0 ([b349299](https://github.com/bytedance/garfish/commit/b349299a2f565e16dd0c40d52aa523379152c648))
+
+
+### Features
+
+* init project ([d6a1b5e](https://github.com/bytedance/garfish/commit/d6a1b5eb18184ac88a3490bc12106edd706bc88e))
+
+
+

CONTRIBUTING.md

@@ -6,7 +6,7 @@
   + 打包介绍
   + 调试流程
 
-garfish 仓库使用 learn 和一些额外的构建脚本共同处理，这意味着，learn 的命令也都是可以用的
+Garfish 仓库使用 learn 和一些额外的构建脚本共同处理，这意味着，learn 的命令也都是可以用的
 ## 开发设置
 如果你想参与 Garfish 的开发或贡献代码，确保你安装以下依赖和插件（vscode 插件）
   + 确保你的 node 为 **，npm 版本为 **
@@ -15,7 +15,7 @@ garfish 仓库使用 learn 和一些额外的构建脚本共同处理，这意
 
 克隆完本仓库后
 ```shell
-  $ npm install # 安装依赖
+  $ npm run setup # 安装依赖
 ```
 
 ## 项目结构
@@ -41,6 +41,7 @@ garfish 仓库使用 learn 和一些额外的构建脚本共同处理，这意
     - `createPackage.js`: 生成新的子包模板工程
     - `utils.js`: 一些工具函数
     - `verifyCommit.js`: commit 信息的校验
+    - `jestTest.js`: 启动单元测试以及测试服务器
 
 ## 打包介绍
 ### Core

README.md

@@ -1,19 +1,38 @@
-## 简介
-Garfish是字节跳动内部自研的微前端框架，提供了从开发调试、服务注册和发现、部署上线、运行的完整解决方案，主要用于解决多团队协作的大型单体应用维护困难的问题。
-<br><br>
-目前在字节跳动内部有超过60个团队，300个项目使用Garfish。
+<h1 align="center">
+  Garfish
+</h1>
+
+[![npm version](https://badge.fury.io/js/%40garfish%2Fcore.svg)](https://badge.fury.io/js/%40garfish%2Fcore)
+
+<p align="center">
+  <img src="http://tosv.byted.org/obj/garfish/Garfish.png" width="150" alt="garfish" />
+</p>
+
+`Garfish` 是字节跳动内部自研的微前端框架，提供了从开发调试、服务注册和发现、部署上线、运行的完整解决方案，主要用于解决多团队协作的大型单体应用维护困难的问题。
+> 目前在字节跳动内部有超过 60 个团队，300 个项目使用 Garfish。
+
 ## 安装
-npm i @garfish/core
+`$ npm i @garfish/core`
 
 ## 快速开始
-todo
+```js
+import Garfish from '@garfish/core';
+
+Garfish.run({
+  domGetter: '#AppContainer',
+  apps: [
+    {
+      name: 'app',
+      entry: 'xx.html',
+      activeWhen: '/index',
+    },
+  ],
+})
+```
 
 ## 文档
-* [API文档](https://github.com/bytedance/garfish/wiki/API)
-* [Build](https://github.com/bytedance/garfish/wiki/Build)
++ [API](https://github.com/bytedance/garfish/wiki/API)
++ [Build](https://github.com/bytedance/garfish/wiki/Build)
 
 ## LICENSE
-
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may obtain a copy of the License at
-http://www.apache.org/licenses/LICENSE-2.0
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+Garfish is released under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

jest.config.js

@@ -4,7 +4,7 @@
 module.exports = {
   clearMocks: true,
   coverageDirectory: 'coverage',
-  coveragePathIgnorePatterns: ['/node_modules/'],
+  coveragePathIgnorePatterns: ['__tests__', '/node_modules/'],
   coverageProvider: 'v8',
   globals: {
     __DEV__: true,
@@ -15,7 +15,7 @@ module.exports = {
   preset: 'ts-jest',
   transformIgnorePatterns: [
     // Change MODULE_NAME_HERE to your module that isn't being compiled
-    '/node_modules/(?!((@garfish)|(byted-tea-sdk))).+\\.js$',
+    '/node_modules/(?!(@garfish)).+\\.js$',
   ],
   transform: { '\\.js$': ['babel-jest'], '\\.ts$': 'ts-jest' },
   rootDir: __dirname,

lerna.json

@@ -11,6 +11,7 @@
     },
     "bootstrap": {
       "ignore": "component-*",
+      "hoist": true,
       "npmClientArgs": [
         "--no-package-lock"
       ]