Skip to content

Commit 3913c69

Browse files
🏈
1 parent 369dac2 commit 3913c69

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

readme.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CF Image proxy
22

3-
> Proxy CDN for caching static assets from third-party domains via [Cloudflare Workers](https://workers.cloudflare.com).
3+
> Image proxy and CDN for [Cloudflare Workers](https://workers.cloudflare.com).
44
55
[![Build Status](https://github.com/transitive-bullshit/cf-image-proxy/actions/workflows/build.yml/badge.svg)](https://github.com/transitive-bullshit/cf-image-proxy/actions/workflows/build.yml) [![Prettier Code Formatting](https://img.shields.io/badge/code_style-prettier-brightgreen.svg)](https://prettier.io)
66

@@ -14,16 +14,14 @@
1414
- Respects `pragma: no-cache` and related headers
1515
- Used in hundreds of prod sites
1616

17-
## Config
17+
## Setup
1818

19-
**All config is defined in [wrangler.toml](./wrangler.toml).**
20-
21-
0. Create a new blank [Cloudflare Worker](https://workers.cloudflare.com).
22-
1. Fork / clone this repo
23-
2. Update the missing values in [wrangler.toml](./wrangler.toml)
24-
3. `npm install`
25-
4. `npm run dev` to test locally
26-
5. `npm run deploy` to deploy to cloudflare workers 💪
19+
1. Create a new blank [Cloudflare Worker](https://workers.cloudflare.com).
20+
2. Fork / clone this repo
21+
3. Update the missing values in [wrangler.toml](./wrangler.toml)
22+
4. `npm install`
23+
5. `npm run dev` to test locally
24+
6. `npm run deploy` to deploy to cloudflare workers 💪
2725

2826
### wrangler.toml
2927

@@ -96,6 +94,12 @@ A few notes about the implementation:
9694
- This means that our worker does not have access to Node.js primitives such as `fs`, `dns` and `http`.
9795
- It does have access to a custom [web fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
9896

97+
## TODO
98+
99+
- [x] Initial release extracted from Notion2Site
100+
- [ ] Support restricting the origin domain in order to prevent abuse
101+
- [ ] Add a snazzy demo
102+
99103
## License
100104

101105
MIT © [Travis Fischer](https://transitivebullsh.it)

0 commit comments

Comments
 (0)