Table of Contents

• Getting Started
  • Installation
  • Usage
  • Contributors
  • License

Brazilian Utils is a library focused on solving problems that we face daily in the development of applications for the Brazilian business.

Using Brazilian Utils is quite simple and you can use it in some ways:

as npm package:

npm install --save @brazilian-utils/brazilian-utils

with yarn package manager:

yarn add @brazilian-utils/brazilian-utils

or <script> tag (global brazilianUtils):

<script src="https://unpkg.com/@brazilian-utils/brazilian-utils/dist/brazilian-utils.cjs.production.min.js"></script>

To use one of our utilities you just need to import the required function as in the example below:

import { isValidCpf } from '@brazilian-utils/brazilian-utils';
isValidCpf('1232454233345'); // false

You can check a list of utilities by clicking here.

Our "thank you" goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind are welcome!

MIT