You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
57 lines
2.5 KiB
57 lines
2.5 KiB
2 years ago
|
[中文](README_CN.md)
|
||
|
|
|
||
|
|
# Licia
|
||
|
|
|
||
|
|
[![NPM version][npm-image]][npm-url]
|
||
|
|
[![Build status][ci-image]][ci-url]
|
||
|
|
[![Test coverage][codecov-image]][codecov-url]
|
||
|
|
[![Size][size-image]][npm-url]
|
||
|
|
[![License][license-image]][npm-url]
|
||
|
|
[![Join the chat at https://gitter.im/liriliri/licia][gitter-image]][gitter-url]
|
||
|
|
|
||
|
|
[gitter-image]: https://img.shields.io/gitter/room/liriliri/licia?style=flat-square
|
||
|
|
[gitter-url]: https://gitter.im/liriliri/licia?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
|
||
|
|
[npm-image]: https://img.shields.io/npm/v/licia?style=flat-square
|
||
|
|
[npm-url]: https://npmjs.org/package/licia
|
||
|
|
[ci-image]: https://img.shields.io/github/actions/workflow/status/liriliri/licia/main.yml?branch=master&style=flat-square
|
||
|
|
[ci-url]: https://github.com/liriliri/licia/actions/workflows/main.yml
|
||
|
|
[codecov-image]: https://img.shields.io/codecov/c/github/liriliri/licia?style=flat-square
|
||
|
|
[codecov-url]: https://codecov.io/github/liriliri/licia?branch=master
|
||
|
|
[license-image]: https://img.shields.io/npm/l/licia?style=flat-square
|
||
|
|
[size-image]: https://img.shields.io/bundlephobia/minzip/licia?style=flat-square
|
||
|
|
|
||
|
|
[Licia](https://licia.liriliri.io/) is a utility library that focus on getting daily works done. Unlike other libraries such as underscore, mout, which strictly separates its functions into several categories like array, string and function etc. licia is just a deadly simple collection of over 400 micro modules dealing problems in different aspects.
|
||
|
|
|
||
|
|
## Benefits
|
||
|
|
|
||
|
|
Installing one library brings you tons of useful utilities:
|
||
|
|
|
||
|
|
* A dom module with jQuery coding style.
|
||
|
|
* A cookie library.
|
||
|
|
* dateFormat that is good enough to handle most date related work.
|
||
|
|
* A Promise polyfill.
|
||
|
|
* A micro event emitter library.
|
||
|
|
* Ajax and its Promise version fetch.
|
||
|
|
* Useful functions from underscore, such as shuffle, unique.
|
||
|
|
* mkdir, like mkdirp the module that has many dependents in npm.
|
||
|
|
* ...
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Just install **licia** and use it like any other npm utility modules such as lodash.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm i licia --save
|
||
|
|
```
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
const uuid = require('licia/uuid');
|
||
|
|
|
||
|
|
console.log(uuid()); // -> 0e3b84af-f911-4a55-b78a-cedf6f0bd815
|
||
|
|
```
|
||
|
|
|
||
|
|
Looking for Licia modules written in ES6 or smaller bundle sizes? Check out [licia-es](https://www.npmjs.com/package/licia-es). There is also an online tool to build a customized utility library, check [here](https://licia.liriliri.io/builder.html).
|
||
|
|
|
||
|
|
## Contribution
|
||
|
|
|
||
|
|
Read [Contributing Guide](.github/CONTRIBUTING.md) for development setup instructions.
|