fixed some typos in readme file and prettified it

This commit is contained in:
satyamk 2023-06-14 23:44:43 +05:30
parent 94cbe4dc7c
commit 24f2b94949

View file

@ -1,14 +1,17 @@
## About ## About
This library is a precompiled version of npm `node-qrcode` package. Github repo for the source code can be found at [node-qrcode](https://github.com/soldair/node-qrcode)
The precompiled library is of version `1.5.3` This library is a precompiled version of npm `node-qrcode` package. Github repo for the source code can be found at [node-qrcode](https://github.com/soldair/node-qrcode). The precompiled library is of version `1.5.3`.
### How to update ### How to update
* Download the source code tar of the new version from github [Release Page](https://github.com/soldair/node-qrcode/tags).
* Extra the tar and run below commands - Download the source code tar of the new version from github [Release Page](https://github.com/soldair/node-qrcode/tags).
- Extract the tar and run below commands:
```bash ```bash
> npm install > npm install
> npm run build > npm run build
``` ```
* This will create a build directory containig the file `qrcode.js`. Copy this file to the vendor directory of project.
* Make sure to add the `module.export` at the end of file to make it work with typescript imports - This will create a build directory containig the file `qrcode.js`. Copy this file to the vendor directory of the project.
* Check the repo and update `license` file if required. - Make sure to add the `module.exports` at the end of the file to make it work with typescript imports (check existing file for example).
- Check the repo and update `license` file if required.