1- LeanCloud JavaScript SDK
2- ====
1+ # LeanCloud JavaScript SDK
2+
33[ ![ npm] ( https://img.shields.io/npm/v/leancloud-storage.svg?style=flat-square )] ( https://www.npmjs.com/package/leancloud-storage )
44![ gzip size] ( http://img.badgesize.io/leancloud/javascript-sdk/dist/dist/av-min.js.svg?compression=gzip&style=flat-square )
55[ ![ Build Status] ( https://img.shields.io/travis/leancloud/javascript-sdk.svg?style=flat-square )] ( https://travis-ci.org/leancloud/javascript-sdk )
66[ ![ Codecov] ( https://img.shields.io/codecov/c/github/leancloud/javascript-sdk.svg?style=flat-square )] ( https://codecov.io/github/leancloud/javascript-sdk )
77[ ![ Known Vulnerabilities] ( https://snyk.io/test/github/leancloud/javascript-sdk/badge.svg?style=flat-square )] ( https://snyk.io/test/github/leancloud/javascript-sdk )
88
9-
109JavaScript SDK for [ LeanCloud] ( http://leancloud.cn/ ) .
1110
1211## 安装
@@ -16,39 +15,37 @@ JavaScript SDK for [LeanCloud](http://leancloud.cn/).
1615npm install leancloud-storage --save
1716// npm 安装 2.x 版本
1817npm install leancloud-storage@2 --save
19-
20- // bower 安装
21- bower install leancloud-storage --save
2218```
23- 文档
24- ----
19+
20+ ## 文档
21+
2522- [ 安装文档] ( https://leancloud.cn/docs/sdk_setup-js.html )
2623- [ 使用文档] ( https://leancloud.cn/docs/leanstorage_guide-js.html )
2724- [ API 文档] ( https://leancloud.github.io/javascript-sdk/docs/ )
2825
29- 支持
30- ----
31- * 如果你发现了新的 bug,或者有新的 feature request,请新建一个 issue
32- * 在使用过程中遇到了问题时
33- * 如果你是商用版用户,请新建一个工单。
34- * 也可以在 [ 论坛] ( https://forum.leancloud.cn/ ) 提问、讨论。
26+ ## 支持
27+
28+ - 如果你发现了新的 bug,或者有新的 feature request,请新建一个 issue
29+ - 在使用过程中遇到了问题时
30+ - 如果你是商用版用户,请新建一个工单。
31+ - 也可以在 [ 论坛] ( https://forum.leancloud.cn/ ) 提问、讨论。
32+
33+ ## 贡献
3534
36- 贡献
37- ----
3835如果你希望为这个项目贡献代码,请按以下步骤进行:
3936
40- * ` fork ` 这个项目
41- * ` npm install ` 安装相关依赖
42- * 开发和调试
43- * 确保测试全部通过 ` npm run test ` ,浏览器环境打开 ` test/test.html `
44- * 提交并发起 ` Pull Request `
37+ - ` fork ` 这个项目
38+ - ` npm install ` 安装相关依赖
39+ - 开发和调试
40+ - 确保测试全部通过 ` npm run test ` ,浏览器环境打开 ` test/test.html `
41+ - 提交并发起 ` Pull Request `
4542
4643项目的目录结构说明如下:
4744
4845```
4946├── dist // 编译之后生成的文件将会在此目录下
5047│ ├── av.js // 浏览器版本
51- │ ├── av-min.js
48+ │ ├── av-min.js
5249│ ├── av-rn.js // React Native 版本
5350│ ├── av-weapp.js // 小程序版本
5451│ ├── av-weapp-min.js
@@ -63,13 +60,12 @@ bower install leancloud-storage --save
6360## 发布流程
6461
65621 . 遵循 semver 提升版本号
66- * src/version.js
67- * package.json
68- * bower.json
69- 0 . 对照 commit 历史写 changelog
70- 0 . 提交当前所有改动
71- 0 . 等待持续集成 pass
72- 0 . 使用 GitHub 基于 dist 分支发布一个 release(for bower)
73- 0 . Fetch and checkout remote ` dist ` branch 并确认该提交的内容是即将发布的版本
74- 0 . npm publish(` npm publish ` ,需 npm 协作者身份),如果是 pre-release 版本需要带 next tag
75- 0 . 发布到 CDN,需要七牛权限(执行 ` gulp upload ` )
63+ - src/version.js
64+ - package.json
65+ 2 . 对照 commit 历史写 changelog
66+ 3 . 提交当前所有改动
67+ 4 . 等待持续集成 pass
68+ 5 . 使用 GitHub 基于 dist 分支发布一个 release
69+ 6 . Fetch and checkout remote ` dist ` branch 并确认该提交的内容是即将发布的版本
70+ 7 . npm publish(` npm publish ` ,需 npm 协作者身份),如果是 pre-release 版本需要带 next tag
71+ 8 . 发布到 CDN,需要七牛权限(执行 ` gulp upload ` )
0 commit comments