CodiceFiscaleJS/readme.md

31 lines
937 B
Markdown
Raw Normal View History

2018-09-03 14:59:53 +02:00
# CodiceFiscale.js
CodiceFiscale.js is a javascript and typescript utility library to compute and validate Italian Italian Tax code (codice fiscale).
2016-03-22 20:23:28 +01:00
2018-09-03 14:59:53 +02:00
## Change log
**Version 2.0.0**
- Added TypeScript support
- Added Object-oriented API
- Improved performance
- Improved error detection
- Backcompatible
2016-03-22 20:23:28 +01:00
2018-09-03 14:59:53 +02:00
## Installation
**Node**
```sh
npm install codice-fiscale-js --save
2017-09-06 00:14:16 +02:00
```
2018-09-03 14:59:53 +02:00
**Web**
```html
<script src="/dist/codice.fiscale.var.js"></script>
```
2018-09-03 14:59:53 +02:00
AMD, UMD e CommonJS version are available. Check `dist` folder
2017-03-10 12:46:46 +01:00
2018-09-03 14:59:53 +02:00
## Docs
2018-09-03 17:16:53 +02:00
- [Javascript](https://github.com/lucavandro/CodiceFiscaleJS/tree/master/docs/js-oop.md)
- [TypeScript](https://github.com/lucavandro/CodiceFiscaleJS/tree/master/docs/typescript.md)
2018-09-03 14:59:53 +02:00
- [Javascript v1.2.0 deprecated](https://github.com/lucavandro/CodiceFiscaleJS/tree/master/docs/js-static.md)
2017-03-10 12:46:46 +01:00
## Available npm scripts:
- `npm run build`: build the bundle into `dist` directory.
2018-09-03 14:59:53 +02:00
- `npm run test`: launch the tests.