4b1cf8b9f1
docs(readme): comprehensive documentation overhaul with architecture and production insights
...
- Add detailed architecture section with factory-driven plugin design
- Document complete decoder/encoder hierarchies and design patterns
- Add implementation details: date handling, Unicode support, tax engine
- Document 100% round-trip data preservation mechanism
- Add production deployment section with security considerations
- Document concurrent processing and memory management best practices
- Add edge case handling examples (empty files, large invoices)
- Include production configuration recommendations
- Add real-world integration patterns (REST API, message queues)
- Create "Why Choose" section highlighting key benefits
- Document three-layer validation approach with EN16931 rules
- Add performance optimizations and resource limit documentation
- Include error recovery mechanisms and debugging strategies
The documentation now provides complete coverage from basic usage through advanced production deployment scenarios.
2025-05-31 11:51:16 +00:00
aea5a5ee26
docs(readme): comprehensive documentation update with API reference
...
- Add Quick Start section with simple usage examples
- Document performance metrics: ~2.2ms validation, ~136KB memory usage
- Add country-specific extensions for XRechnung, FatturaPA, and Factur-X
- Include detailed error handling examples and troubleshooting guide
- Add API reference with EInvoice class methods and types
- Document all supported export formats and validation levels
- Add performance benchmarking examples
- Expand test documentation with verbose output options
- Add format conversion examples showing data preservation
- Include recent improvements and version 2.0.0 features
2025-05-30 18:17:15 +00:00
a93ea090ce
BREAKING CHANGE(core): Rebrand XInvoice to EInvoice: update package name, class names, imports, and documentation
2025-05-24 16:33:58 +00:00
17e2b2d6dd
fix(documentation): Improve readme documentation for better clarity on PDF handling, XML validation and error reporting
2025-04-04 13:34:30 +00:00
6b40eac61f
fix(readme): Update readme documentation: enhance feature summary, update installation instructions and usage examples, remove obsolete config details, and better clarify supported invoice formats.
2025-04-03 20:45:26 +00:00
e929281861
update
2025-03-17 16:30:23 +00:00
a5ce55bbc8
fix(documentation): Update readme to enhance installation instructions and expand feature documentation for Factur-X/ZUGFeRD, UBL, and FatturaPA support, including details on circular encoding/decoding.
2025-03-17 15:28:55 +00:00
3f91ea44ab
fix(core): Fix file import paths and remove markdown syntax from README
2025-01-01 05:44:55 +01:00
884f98439c
fix(documentation): Updated documentation to reflect accurate module description and usage guidance
2024-12-31 13:41:45 +01:00
8bde0f1d21
fix(core): update
2024-04-22 16:30:55 +02:00