Após um longo hiato, queremos começar pedindo desculpas por não termos dado a devida atenção à biblioteca. Mas temos ótimas notícias: em 2025, voltaremos com tudo! 🎉

Aqui está o que estamos planejando:

• Refatoração do código: Vamos simplificar e padronizar a estrutura do projeto para facilitar contribuições e torná-lo mais acessível a todos.
• Nova documentação: Teremos uma documentação renovada, abrangendo não apenas a biblioteca em JavaScript, mas também versões em outras linguagens.
• Publicação da versão 1.0: Finalmente, lançaremos a V1 oficial, acompanhada de um guia de migração completo para facilitar a atualização.
• Resolução de issues abertas: Nos comprometemos a revisar e resolver todas as issues pendentes da comunidade.

Estamos super empolgados com o futuro do projeto e esperamos que vocês também estejam! 🎊

Por favor, fiquem à vontade para abrir issues ou iniciar discussions. Vamos construir algo incrível juntos! ❤️

📖 Documentation

Table of Contents

• Getting Started
  • Installation
  • Usage
  • Contributors
  • License

Getting Started

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

Installation

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>

Usage

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.

Contributors

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

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

License

MIT