Skip to content

Commit

Permalink
fix: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hudsonbrendon committed Mar 28, 2024
1 parent 17db1aa commit fccda4b
Showing 1 changed file with 37 additions and 2 deletions.
39 changes: 37 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
# Pydantic BR Validator

Uma biblioteca python com modelos de validação para os principais documentos brasileiros.
<p align="center">
<a href="https://sqlmodel.tiangolo.com"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/0/05/Flag_of_Brazil.svg/1600px-Flag_of_Brazil.svg.png" alt="Pydantic BR Validator"></a>
</p>
<p align="center">
<em>Uma biblioteca python com modelos de validação para os principais documentos brasileiros.</em>
</p>
<p align="center">
<a href="https://github.com/hudsonbrendon/pydantic-br-validator/actions/workflows/pythonpackage.yml" target="_blank">
<img src="https://github.com/hudsonbrendon/pydantic-br-validator/actions/workflows/pythonpackage.yml/badge.svg?branch=master" alt="Test">
</a>
<a href="https://pypi.org/project/pydantic-br-validator" target="_blank">
<img src="https://img.shields.io/pypi/v/pydantic-br-validator?color=%2334D058&label=pypi%20package" alt="Package version">
</a>
<a href="https://pypi.org/project/pydantic-br-validator" target="_blank">
<img src="https://img.shields.io/pypi/pyversions/pydantic-br-validator.svg?color=%2334D058" alt="Supported Python versions">
</a>
</p>

---

# Instalação

Expand All @@ -10,6 +28,21 @@ pip install pydantic-br-validator

# Campos disponíveis

- [x] CPF
- [x] CNPJ
- [ ] RG
- [ ] CNH
- [ ] DUT
- [ ] Título de eleitor
- [ ] PIS
- [ ] Certidão de nascimento
- [ ] Renavam
- [ ] Placa
- [ ] ISBN
- [ ] CEP

# Exemplos

## CPF

```python
Expand Down Expand Up @@ -60,4 +93,6 @@ cliente = Cliente(
pprint(cliente.dict())
```

# Contribua 🚀
# Licença

Este projeto está licenciado sob os termos da licença do [MIT licença](https://en.wikipedia.org/wiki/MIT_License)

0 comments on commit fccda4b

Please sign in to comment.