Skip to content

Latest commit

 

History

History
135 lines (91 loc) · 2.89 KB

README-zh_CN.md

File metadata and controls

135 lines (91 loc) · 2.89 KB

license CI npm NPM downloads Percentage of issues still open

简单好用的JS全局ID生成工具,原生兼容IE6

English | 简体中文

兼容性

单元测试保证支持如下环境:

IE CH FF SF OP IOS 安卓 Node
6+ 23+ 4+ 6+ 10+ 5+ 2.3+ 0.10+

目录介绍

.
├── demo 使用demo
├── dist 编译产出代码
├── doc 项目文档
├── src 源代码目录
├── test 单元测试
├── CHANGELOG.md 变更日志
└── TODO.md 计划功能

如何使用

通过npm下载安装代码

$ npm install --save @jsmini/guid

如果你是node环境

var guid = require('@jsmini/guid').guid;

guid();

如果你是webpack等环境

import { guid } from '@jsmini/guid';

guid();

如果你是requirejs环境

requirejs(
  ['node_modules/@jsmini/guid/dist/index.aio.js'],
  function (jsmini_guid) {
    var guid = jsmini_guid.guid;

    guid();
  },
);

如果你是浏览器环境

<script src="node_modules/@jsmini/guid/dist/index.aio.js"></script>

<script>
  var guid = jsmini_guid.guid;

  guid();
</script>

文档

API

贡献指南 PRs welcome

首次运行需要先安装依赖

$ npm install

一键打包生成生产代码

$ npm run build

运行单元测试,浏览器环境需要手动测试,位于test/browser

$ npm test

修改package.json中的版本号,修改README.md中的版本号,修改CHANGELOG.md,然后发布新版

$ npm run release

将新版本发布到npm

$ npm publish --access=public

可能需要你自己修改的地方如下:

  • README.md 中的信息
  • package.json 中的信息
  • config/rollup.js 中的信息
  • test/browser/index.html 中的仓库名称

更新日志

CHANGELOG.md

计划列表

TODO.md

谁在使用