-
-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |