Skip to content

Commit

Permalink
readme and docs typo fix
Browse files Browse the repository at this point in the history
  • Loading branch information
leogregianin committed Feb 24, 2025
1 parent bd92e68 commit 7f8f44a
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 9 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Check the [documentation](https://engenere.github.io/BrazilFiscalReport/) for mo
- [FPDF2](https://github.com/py-pdf/fpdf2) - PDF creation library for Python
- phonenumbers
- python-barcode
- qrcode (only required for DACTE)
- qrcode (required for DACTE and DAMDFE)

## To install 🔧

Expand All @@ -40,14 +40,21 @@ pip install brazilfiscalreport
If you specifically need the DACTE functionality, you can install it along with its required dependencies using:

```bash
pip install brazilfiscalreport[dacte]
pip install 'brazilfiscalreport[dacte]'
```

## Installing DAMDFE with Dependencies
If you specifically need the DAMDFE functionality, you can install it along with its required dependencies using:

```bash
pip install 'brazilfiscalreport[damdfe]'
```

### Installing CLI with Dependencies
If you specifically need the CLI functionality, you can install it along with its required dependencies using:

```bash
pip install brazilfiscalreport[cli]
pip install 'brazilfiscalreport[cli]'
```

## Credits 🙌
Expand Down
4 changes: 2 additions & 2 deletions docs/damdfe.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Here’s how to set up a DamdfeConfig object with a full set of customizations:
```python
from brazilfiscalreport.damdfe import (
Damdfe,
DacteConfig,
DamdfeConfig,
FontType,
Margins,
)
Expand All @@ -100,5 +100,5 @@ config = DamdfeConfig(

# Use this config when creating a Damdfe instance
damdfe = Damdfe(xml_content, config=config)
damdfe.output('output_dacte.pdf')
damdfe.output('output_damdfe.pdf')
```
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This library is currently in the beta stage of development. While it has many of
- [FPDF2](https://github.com/py-pdf/fpdf2) - PDF creation library for Python
- phonenumbers
- python-barcode
- qrcode (only required for DACTE)
- qrcode (required for DACTE and DAMDFE)

## To install 🔧

Expand All @@ -46,19 +46,19 @@ pip install brazilfiscalreport
If you specifically need the DACTE functionality, you can install it along with its required dependencies using:

```bash
pip install brazilfiscalreport[dacte]
pip install 'brazilfiscalreport[dacte]'
```

## Installing DAMDFE with Dependencies
If you specifically need the DAMDFE functionality, you can install it along with its required dependencies using:

```bash
pip install brazilfiscalreport[damdfe]
pip install 'brazilfiscalreport[damdfe]'
```

### Installing CLI with Dependencies
If you specifically need the CLI functionality, you can install it along with its required dependencies using:

```bash
pip install brazilfiscalreport[cli]
pip install 'brazilfiscalreport[cli]'
```

0 comments on commit 7f8f44a

Please sign in to comment.