jsmini / storage

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

建设中

license Build Status npm NPM downloads Percentage of issues still open

一组小而美的JS库,jsmini脚手架,fork或clone本仓库,即可搭建完成一个新的jsmini库

兼容性

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

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

注意:编译代码依赖ES5环境,对于ie6-8需要引入es5-shim才可以兼容,可以查看demo/demo-global.html中的例子

目录介绍

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

如何使用

通过npm下载安装代码

$ npm install --save @jsmini/storage

如果你是node环境

var name = require('@jsmini/storage').name;

如果你是webpack等环境

import { name } from '@jsmini/storage';

如果你是requirejs环境

requirejs(['node_modules/@jsmini/storage/dist/index.aio.js'], function (jsmini_storage) {
    var name = jsmini_storage.name;
})

如果你是浏览器环境

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

<script>
    var name = jsmini_storage.name;
</script>

文档

API

贡献指南

首次运行需要先安装依赖

$ npm install

一键打包生成生产代码

$ npm run build

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

$ npm test

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

$ npm run release

将新版本发布到npm

$ npm publish --access=public

重命名项目名称,首次初始化项目是需要修改名字,或者后面项目要改名时使用,需要修改rename.js中的fromNametoName,会自动重命名下面文件中的名字

  • README.md 中的信息
  • package.json 中的信息
  • config/rollup.js 中的信息
  • test/browser/index.html 中的仓库名称
$ npm run rename # 重命名命令

贡献者列表

contributors

更新日志

CHANGELOG.md

计划列表

TODO.md

谁在使用

About

License:MIT License


Languages

Language:JavaScript 75.0%Language:HTML 25.0%