Skip to content

Commit

Permalink
update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
BeeeQueue committed Jun 19, 2022
1 parent 65c2765 commit f8ba17f
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 8 deletions.
5 changes: 5 additions & 0 deletions .changeset/small-eggs-pull.md
@@ -0,0 +1,5 @@
---
"esbuild-cf-functions-plugin": minor
---

Initial release
14 changes: 6 additions & 8 deletions README.md
@@ -1,17 +1,15 @@
# `esbuild-cf-functions-plugin`

<!--
[![npm](https://img.shields.io/npm/v/NAME_HERE)](https://www.npmjs.com/package/NAME_HERE)
![npm bundle size](https://img.shields.io/bundlephobia/minzip/NAME_HERE)
![node-current](https://img.shields.io/node/v/NAME_HERE)
[![Codecov](https://img.shields.io/codecov/c/github/BeeeQueue/NAME_HERE?token=TOKEN_HERE)](https://app.codecov.io/github/BeeeQueue/NAME_HERE)
-->
[![npm](https://img.shields.io/npm/v/esbuild-cf-functions-plugin)](https://www.npmjs.com/package/esbuild-cf-functions-plugin)
![node-current](https://img.shields.io/node/v/esbuild-cf-functions-plugin)
![esbuild-current](https://img.shields.io/badge/esbuild-^0.14.46-green)
[![Codecov](https://img.shields.io/codecov/c/github/BeeeQueue/esbuild-cf-functions-plugin?token=TOKEN_HERE)](https://app.codecov.io/github/BeeeQueue/esbuild-cf-functions-plugin)

This plugin configures ESBuild for building code [compatible][runtime] with [CloudFront Functions][cf-functions].

As can be seen in the documentation CloudFront Functions do not run on Node, but on AWS's custom JS runtime.
As can be seen in the documentation, CloudFront Functions do not run on Node, but on AWS's custom JS runtime.

According to them it
According to them, it

> ... is compliant with ECMAScript (ES) version 5.1 and also supports some features of ES versions 6 through 9.
Expand Down
9 changes: 9 additions & 0 deletions example/README.md
@@ -0,0 +1,9 @@
# Redirect example

This example shows a set up where a TypeScript function is build and deployed to CloudFront Functions via Terraform!

The function does one thing: if the path starts with `/foo*` it will redirect it to `/bar*`.

This can be tested by visiting the URL below and seeing the path change from `/foo/nebula.webp` to `/bar/nebula.webp`!

https://d31lz94z7iimag.cloudfront.net/foo/nebula.webp
3 changes: 3 additions & 0 deletions package.json
Expand Up @@ -37,6 +37,9 @@
"release": "pnpm build && pnpm changeset publish",
"prepare": "simple-git-hooks"
},
"peerDependencies": {
"esbuild": "^0.14.46"
},
"devDependencies": {
"@beequeue/eslint-plugin": "0.6.0",
"@changesets/changelog-github": "0.4.5",
Expand Down

0 comments on commit f8ba17f

Please sign in to comment.