Skip to content

Commit 9be2e85

Browse files
committed
[doc] 优化文档内容。
1 parent 4834cac commit 9be2e85

File tree

1 file changed

+12
-75
lines changed

1 file changed

+12
-75
lines changed

README.md

Lines changed: 12 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -13,78 +13,31 @@ JavaScript SDK for [LeanCloud](http://leancloud.cn/).
1313

1414
* fork 这个项目
1515
* 在本地进行调试,`npm install` 安装相关依赖
16-
* 执行 `gulp browserify` 会生成浏览器 SDK
17-
* 服务环境可以通过单元测试调试
18-
* 确保 `gulp test` 的测试全部通过,浏览器环境打开 test/test.html
16+
* 执行 `gulp browserify` 会生成浏览器 SDK
17+
* 执行 `gulp release` 会生成全部版本的 SDK
18+
* 服务环境可以通过单元测试调试,浏览器环境打开 test/test.html
19+
* 确保 `gulp test` 的测试全部通过
1920
* 提交并发起 PR
2021

2122
项目的目录结构说明如下:
2223

2324
```
24-
├── README.md
25+
├── README.md // 说明文档
2526
├── bower.json
2627
├── changelog.md
2728
├── dist // 编译之后生成的文件将会在此目录下
2829
├── gulpfile.js
2930
├── lib
30-
│ ├── acl.js
3131
│ ├── av-browser.js // 浏览器环境入口文件,将会被 browserify 编译
3232
│ ├── av-browser-core.js // 浏览器环境入口文件,只包含核心依赖,将会被 browserify 编译
3333
│ ├── av.js // node.js 环境入口文件
3434
│ ├── bigquery.js
3535
│ ├── browserify-wrapper // 针对 node.js 与浏览器环境之间差异的不同实现
36-
│ │ ├── localstorage-browser.js
37-
│ │ ├── parse-base64-browser.js
38-
│ │ ├── parse-base64.js
39-
│ │ ├── upload-browser.js
40-
│ │ ├── upload.js
41-
│ │ └── xmlhttprequest-browser.js
42-
│ ├── cloud.js
43-
│ ├── cloudfunction.js
44-
│ ├── collection.js
45-
│ ├── error.js
46-
│ ├── event.js
47-
│ ├── facebook.js
48-
│ ├── file.js
49-
│ ├── geopoint.js
50-
│ ├── history.js
51-
│ ├── insight.js
52-
│ ├── object.js
53-
│ ├── op.js
54-
│ ├── promise.js
55-
│ ├── push.js
56-
│ ├── query.js
57-
│ ├── relation.js
58-
│ ├── role.js
59-
│ ├── router.js
60-
│ ├── search.js
61-
│ ├── status.js
62-
│ ├── user.js
63-
│ ├── utils.js
64-
│ ├── version.js
65-
│ └── view.js
36+
│ └── ...
6637
├── package.json
6738
├── readme.txt
6839
├── test // 单元测试
69-
│ ├── acl.js
70-
│ ├── bigquery.js
71-
│ ├── cloud.js
72-
│ ├── collection.js
73-
│ ├── error.js
74-
│ ├── file.html
75-
│ ├── file.js
76-
│ ├── file_blob.html
77-
│ ├── file_form.html
78-
│ ├── geopoints.js
79-
│ ├── object.js
80-
│ ├── promise.js
81-
│ ├── query.js
82-
│ ├── search.js
83-
│ ├── sms.js
84-
│ ├── status.js
85-
│ ├── test.html
86-
│ ├── test.js
87-
│ └── user.js
40+
│ └── ...
8841
└── tools // 构建中依赖的第三方工具
8942
```
9043

@@ -94,30 +47,14 @@ JavaScript SDK for [LeanCloud](http://leancloud.cn/).
9447
* lib/version.js
9548
* package.json
9649
* bower.json
97-
9850
* 修改 Changelog
99-
100-
* 打包 Release
101-
102-
```
103-
gulp release
104-
```
105-
51+
* 打包(执行 `gulp release`
10652
* 提交当前所有代码
10753
* 版本号相关修改
10854
* change log
10955
* dist/ 目录中的新代码
110-
11156
* 提交代码,发 pull request
112-
113-
* (merge 后)Github 生成 release 包(for bower)
114-
115-
* 发布到 npm(需 npm 协作者身份)
116-
```
117-
npm publish
118-
```
119-
120-
* 发布到 CDN(需要七牛权限)
121-
```
122-
gulp upload
123-
```
57+
* 通过 review,merge 代码
58+
* Github 生成 release 包(for bower)
59+
* 发布到 npm,需 npm 协作者身份(执行 `npm publish`
60+
* 发布到 CDN,需要七牛权限(执行 `gulp upload`

0 commit comments

Comments
 (0)