Skip to content

Commit

Permalink
docs: add api overview
Browse files Browse the repository at this point in the history
  • Loading branch information
schoero committed Nov 1, 2023
1 parent 3a22d34 commit bf35941
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# SwissQRBill

All documentation is located in the [docs](./) directory.

## Getting started

To help you get started, you can follow the guide [how to create a complete qr bill](./quick-start.md) to create your first QR bill.

## Importing

Depending on the environment you are using, you may need to import the library differently. The following documentation will help you find the best way to import the library for your environment.

- [Node.js: ES Module](./importing.md#nodejs-es-module-import)
- [Node.js: CommonJS](./importing.md#nodejs-commonjs-import)
- [Browser: Bundling with webpack](./importing.md#browser-bundling-with-webpack)
- [Browser: Pre-built bundle](./importing.md#browser-pre-built-bundle)

## API documentation

SwissQRBill exposes different classes and functions that can be used to create a QR bill. The API is split into different parts, depending on the use case.

- [PDF](./pdf/index.md)
- [SwissQRBill](./pdf/index.md#swissqrbill)
- [SwissQRCode](./pdf/index.md#swissqrcode)
- [Table](./pdf/index.md#table)
- [SVG](./svg/index.md)
- [SwissQRBill](./svg/index.md#swissqrbill)
- [SwissQRCode](./svg/index.md#swissqrcode)
- [Utils](./utils/utils.md)
- [bundle](./bundle/index.md)

0 comments on commit bf35941

Please sign in to comment.