Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: marketing mumbo-jumbo #62

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/base/multipart/readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `@hattip/multipart`

> ⚠️ This package is work in progress. Please don't use in user-facing production code as it may have security issues.
> ⚠️ This package is work in progress. It may have (security) issues.

Multipart parser for HatTip. It can be used to parse multipart requests, especially `multipart/form-data` for handling file uploads.

Expand Down
12 changes: 8 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@ Chat: <a href="https://discord.com/invite/vTvXzBMySh">Discord > Cubes<img src=".

**Why HatTip?**

Instead of writing server code that only works with Express.js, write server code that can be deployed anywhere: AWS, Cloudflare Workers, Vercel, VPS, ...
With HatTip you write server code that can be deployed anywhere: Cloudflare Workers, AWS EC2, AWS Lambda, Vercel, Netlify, Deno Deploy, Lagon, ...

HatTip prevents vendor locking by abstracting away the underlying platforms. Vercel is getting too expensive? Switch to Cloudflare Workers. Node is becoming too slow? Migrate to Bun. Without changing a single line of application code.
Copy link
Contributor

@aleclarson aleclarson Nov 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
HatTip prevents vendor locking by abstracting away the underlying platforms. Vercel is getting too expensive? Switch to Cloudflare Workers. Node is becoming too slow? Migrate to Bun. Without changing a single line of application code.
HatTip prevents vendor lock-in by abstracting away the underlying platforms. Vercel getting too expensive? Switch to Cloudflare Workers. Node.js becoming a bottleneck? Migrate to Bun. All without a single change to your application's request/response handling.


HatTip is designed so that you can still fully tap into the underlying platform. As the need arises at scale, you can focus on a deployment platform and fully leverage its features that make it special.
Copy link
Contributor

@aleclarson aleclarson Nov 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe something like this instead:

Suggested change
HatTip is designed so that you can still fully tap into the underlying platform. As the need arises at scale, you can focus on a deployment platform and fully leverage its features that make it special.
HatTip lets you use special features of the underlying platform. If you do this, it might be harder to move your app to a different platform later. But you can choose to do this if it helps your app work better.


With HatTip, you get a quick deployment-agnostic start with the ability to seamlessly change deployment providers, while keeping full control and freedom down the line.

**What is HatTip?**

Expand Down Expand Up @@ -183,14 +189,12 @@ HatTip is extremely modular so you can use as little or as much as you need:
- [`router`](./packages/base/router): Express-style imperative router
- [`response`](./packages/base/response): Utility functions for creating text, JSON, HTML, and server-sent event responses
- [`headers`](./packages/base/headers): Header value parsing and content negotiation utilities
- [`multipart`](./packages/base/multipart): Experimental multipart parser (e.g. for form data with file uploads)
- [`multipart`](./packages/base/multipart): Multipart parser (e.g. forms and file uploads)
- [`cookie`](./packages/middleware/cookie): Cookie handling middleware
- [`cors`](./packages/middleware/cors): CORS middleware
- [`graphql`](./packages/middleware/graphql): GraphQL middleware
- [`session`](./packages/middleware/session): Session middleware

A zero-config development environment based on [Vite](https://vitejs.dev) is also in the works.

## Credits

[MIT license](./LICENSE)
Expand Down