feat:update npmClient

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [xinhui.zxh@antfin.com]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

README.md

@@ -1,11 +1,55 @@
 ## Graphin
 
-![Graphin](https://gw.alipayobjects.com/mdn/rms_00edcb/afts/img/A*EkJmRrmuJAgAAAAAAAAAAABkARQnAQ)
+Graphin 采用 lerna 包管理，分为以下 4 个包
 
-> 名称由来：Graphin 取名意为 Graph Insight（图的分析洞察），是一个基于 G6 封装的 React 组件库，简单，高效，开箱即用。
+-   graphin
+-   graphin-components
+-   graphin-studio
+-   graphin-site
 
-虽然 Graphin 是基于 G6 封装的 React 组件库，这只是它的技术实现，并不是它的产品定位。Graphin 专注在图分析领域，准确来讲，它是对 G6 网图的一种扩展与应用，因此它并不能全部 覆盖 G6 的现有能力，比如绘制流程图，绘制桑基图，以及绘制各种 产品经理 开脑洞的图。
-但是它也有它的可爱之处，因为聚焦，所以更加强大，集成业界优秀图分析产品的功能特性，在关系分析，知识图谱，金融反欺诈，物流安全等领域有着广泛的应用。
-Graphin 的有一颗想做产品的心，开源后，我们将对标商业图分析工具 ReGraph 去打造，因为，这次发布的主题是“抛砖引玉”，希望更多的人加入我们，在图分析这个领域探索
+### Get Started
 
-11 月 22 日开源，comming soon ...
+-   设置 npmClient
+
+在 lerna.json 中设置你的 npmClient，中国地区的朋友可以设置 [cnpm](https://www.npmjs.com/package/cnpm)
+
+```json
+// ./lerna.json
+{
+    "packages": ["packages/*"],
+    "npmClient": "cnpm",
+    "version": "0.0.0"
+}
+```
+
+-   安装依赖
+
+```bash
+cnpm i
+```
+
+-   安装各 packages 的依赖
+
+```bash
+npm run bootstrap
+```
+
+-   启动 graphin 与 graphin-components 的 start 本地编译
+
+```bash
+npm run start
+```
+
+> 在`npm run start`后
+
+-   查看 graphin-studio 的 demo 示例
+
+```bash
+npm run studio
+```
+
+-   查看 graphin-sire 的 gatsby 官方
+
+```bash
+npm run site
+```

lerna.json

@@ -2,6 +2,6 @@
   "packages": [
     "packages/*"
   ],
-  "npmClient": "tnpm",
+  "npmClient": "cnpm",
   "version": "0.0.0"
 }

package.json

@@ -1,7 +1,9 @@
 {
     "name": "graphin",
     "scripts": {
-        "start": "lerna run start --parallel --ignore graphin-site --npm-client=tnpm",
+        "start": "lerna run start --parallel  --ignore @antv/graphin-studio --ignore graphin-site --npm-client=npm",
+        "site": "cd ./packages/graphin-site && npm run start",
+        "studio": "cd ./packages/graphin-studio && npm run start",
         "bootstrap": "lerna bootstrap",
         "build": "lerna run build",
         "contributor": "git-contributor",