diff --git a/README.md b/README.md index 0729f19f..5ede3ab2 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,16 @@

Cats Cradle :yarn:

-Get ready to embark on an adventure with **Cats Cradle** - the upcoming co-op RPG that will transport you to a nostalgic world filled with wonder. Join -us on this exciting journey as we continue to develop and bring this game to -life. +Get ready to embark on an adventure with **Cats Cradle** - the upcoming co-op +RPG that will transport you to a nostalgic world filled with wonder. Join us on +this exciting journey as we continue to develop and bring this game to life. This repo houses the game's code. This enterprise architecture monorepo includes numerous microservices built on a PaaS with IaC for streamlined DevOps CI/CD. -Although each package is maintained primarily for the game, most are -individually published to [NPM](https://www.npmjs.com/search?q=%40cats-cradle) -and available under open-source software license. +Although each package is maintained primarily for the game, most stable packages +are individually published to +[NPM](https://www.npmjs.com/search?q=%40cats-cradle) and available under +open-source software license. [![CI](https://github.com/hxtree/cats-cradle/actions/workflows/on-merge.yml/badge.svg)](https://github.com/hxtree/cats-cradle/actions/workflows/on-merge.yml) [![Code Quality](https://app.codacy.com/project/badge/Grade/8024531285164025aef972fcb059ea74)](https://www.codacy.com/gh/hxtree/cats-cradle/dashboard?utm_source=github.com&utm_medium=referral&utm_content=hxtree/cats-cradle&utm_campaign=Badge_Grade) diff --git a/services/html-to-pdf/CHANGELOG.json b/services/html-to-pdf/CHANGELOG.json new file mode 100644 index 00000000..60ba9526 --- /dev/null +++ b/services/html-to-pdf/CHANGELOG.json @@ -0,0 +1,17 @@ +{ + "name": "@cats-cradle/html-to-pdf", + "entries": [ + { + "version": "1.0.5", + "tag": "@cats-cradle/html-to-pdf_v1.0.5", + "date": "Mon, 23 Oct 2023 12:23:42 GMT", + "comments": { + "patch": [ + { + "comment": "Add repo info to package.json" + } + ] + } + } + ] +} diff --git a/services/html-to-pdf/CHANGELOG.md b/services/html-to-pdf/CHANGELOG.md new file mode 100644 index 00000000..ad382849 --- /dev/null +++ b/services/html-to-pdf/CHANGELOG.md @@ -0,0 +1,11 @@ +# Change Log - @cats-cradle/html-to-pdf + +This log was last generated on Mon, 23 Oct 2023 12:23:42 GMT and should not be manually modified. + +## 1.0.5 +Mon, 23 Oct 2023 12:23:42 GMT + +### Patches + +- Add repo info to package.json + diff --git a/services/html-to-pdf/README.md b/services/html-to-pdf/README.md index d4acd588..26378958 100644 --- a/services/html-to-pdf/README.md +++ b/services/html-to-pdf/README.md @@ -8,7 +8,8 @@ HTMLtoPDF is a high-performance microservice built to empower web developers with a streamlined way to generate professional PDFs from HTML content. We firmly believe that HTML, a language that's approachable for web development -beginners, should also be the preferred choice for PDF generation. +beginners, should also be the preferred choice for most programmatic PDF +generation. Tired of complex PDF libraries and clunky alternatives like FPDF or TCPDF? HTMLtoPDF simplifies the entire process, making PDF generation a breeze. Say @@ -17,16 +18,20 @@ embrace a brighter future for PDF creation. ## Quick Start -Generating PDFs with HTMLtoPDF is as easy as pie. Just run cdk:deploy and send a -URL or HTML input request to the API endpoint: +Generating PDFs with HTMLtoPDF is as easy as pie. Just deploy service to AWS by +running command `cdk:deploy` and send request containing either a URL or HTML to +the API Gateway endpoint: ```bash -curl -X POST https://nx7uv2rfy4.execute-api.us-east-2.amazonaws.com/default/v1/html-to-pdf/pdf -H "Content-Type: application/json" -d '{"input": "URL", "output": "PDF", "url": "https://google.com"}' -o example.pdf +curl -X POST https://nx7uv2rfy4.execute-api.us-east-2.amazonaws.com/default/v1/html-to-pdf/pdf \ +-H "Content-Type: application/json" \ +-d '{"input": "URL", "output": "PDF", "url": "https://google.com"}' \ +-o example.pdf ``` -Example Output: +Output: -![Example Image](./example.png) +![Example Image](https://github.com/hxtree/cats-cradle/raw/main/services/html-to-pdf/example.png) ## How it Works diff --git a/services/html-to-pdf/package.json b/services/html-to-pdf/package.json index d05d48ce..bf91b790 100644 --- a/services/html-to-pdf/package.json +++ b/services/html-to-pdf/package.json @@ -1,9 +1,16 @@ { "name": "@cats-cradle/html-to-pdf", "module": "commonjs", - "version": "1.0.4", + "version": "1.0.5", "license": "MIT", "description": "Your Go-To Solution for PDF Generation from HTML.", + "bugs": { + "url": "https://github.com/hxtree/cats-cradle/issues" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/hxtree/cats-cradle.git" + }, "bin": { "app": "bin/app.js" },