Skip to content

Commit

Permalink
feat: add repo info to html to pdf package.json
Browse files Browse the repository at this point in the history
Signed-off-by: hxtree <[email protected]>
  • Loading branch information
hxtree committed Oct 23, 2023
1 parent 1c7e27a commit 365f3a9
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 12 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
<h1 align="center">Cats Cradle :yarn:</h1>

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)
Expand Down
17 changes: 11 additions & 6 deletions services/html-to-pdf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down
7 changes: 7 additions & 0 deletions services/html-to-pdf/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
"version": "1.0.4",
"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"
},
Expand Down

0 comments on commit 365f3a9

Please sign in to comment.