npm package: @jsmini/md5
Description: 最好用的js第三方库脚手架
Author: yanhaijing
Latest version: 0.2.2

# [md5](https://github.com/jsmini/md5) 

[![](https://img.shields.io/badge/Powered%20by-jslib%20base-brightgreen.svg)](https://github.com/yanhaijing/jslib-base)
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jsmini/md5/blob/master/LICENSE)
[![Build Status](https://travis-ci.org/jsmini/md5.svg?branch=master)](https://travis-ci.org/jsmini/md5)
[![Coveralls](https://img.shields.io/coveralls/jsmini/md5.svg)](https://coveralls.io/github/jsmini/md5)
[![npm](https://img.shields.io/badge/npm-0.2.2-orange.svg)](https://www.npmjs.com/package/@jsmini/md5)
[![NPM downloads](http://img.shields.io/npm/dm/@jsmini/md5.svg?style=flat-square)](http://www.npmtrends.com/@jsmini/md5)
[![Percentage of issues still open](http://isitmaintained.com/badge/open/jsmini/md5.svg)](http://isitmaintained.com/project/jsmini/base "Percentage of issues still open")

Hashing string with MD5

md5生成函数

English | [简体中文](./README-zh_CN.md)

## Environment Support

unit test ensure it supports the following environments.

| IE/Edge | Chrome | Firefox | Safari | Opera | IOS  | Android | Node  |
| ------- | ------ | ------- | ------ | ----- | ---- | ------- | ----- |
| 6+      | 23+    | 4+      | 6+     | 10+   | 5+   | 2.3+    | 0.10+ |

**Notice:  builds depends on ES5. In order to support IE6-8,  you should import  [es5-shim](http://github.com/es-shims/es5-shim/) . See example in [demo/demo-global.html](./demo/demo-global.html)**

## Directory

```
.
├── demo
├── dist  # production code
├── doc   # document
├── src   # source code
├── test  # unit test
├── CHANGELOG.md
└── TODO.md
```

## Usage
npm installation

```bash
$ npm install --save @jsmini/md5
```

Node.js

```js
var name = require('@jsmini/md5').name;
```

webpack

```js
import { name } from '@jsmini/md5';
```

Require.js

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

Browser

```html
<script src="node_modules/@jsmini/md5/dist/index.aio.js"></script>

<script>
    var name = jsmini_md5.name;
</script>
```

## Document

[API](https://github.com/jsmini/md5/blob/master/doc/api.md)

## Contributing Guide  ![PRs welcome](<https://img.shields.io/badge/PRs-welcome-brightgreen.svg>)
when initialize, install dependencies 

```bash
$ npm install
```

builds your code for production to `build` folder

```bash
$ npm run build
```

run unit test.  notice: borwser enviroment need to test manually.  test file is in `test/browser`

```bash
$ npm test
```

change  the  version in package.json and README.md, add your description in CHANGELOG.md, and then release it happily.

```bash
$ npm run release
```

publish the new package to npm

```bash
$ npm publish --access=public
```

rename  project. you need to edit project name when initialize project or anytime you want to rename the project . you need to rename `formName` and `toname` in file `rename.js`,which will automatically rename project name in the following files

- README.md
- package.json
- config/rollup.js
- test/browser/index.html

```bash
$ npm run rename # rename command
```

## Contributors
[contributors](https://github.com/jsmini/md5/graphs/contributors)

## CHANGELOG
[CHANGELOG.md](https://github.com/jsmini/md5/blob/master/CHANGELOG.md)

## TODO
[TODO.md](https://github.com/jsmini/md5/blob/master/TODO.md)

## who is using