Skip to content

Commit

Permalink
fix: Formatting in README. (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
vlidholt authored Dec 17, 2024
1 parent e3f1f78 commit 0aaf3d4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Relic
![Relic web server banner](https://github.com/serverpod/relic/raw/main/misc/images/github-banner.jpg)

# Relic web server

Relic is a web server based on Shelf that supports middleware. It's currently available as a tech preview to gather feedback before we release a stable version. __Beware that the API is still subject to change.__ The best way to provide your feedback is through issues on GitHub here:
[https://github.com/serverpod/relic/issues](https://github.com/serverpod/relic/issues)

This package was born out of the needs of [Serverpod](https://serverpod.dev), as we wanted a more modern and performant base for our web server. Relic is based on [Shelf](https://pub.dev/packages/shelf), but we have made several improvements:

- We removed all List<int> in favor of Uint8List.
- We removed all `List<int>` in favor of `Uint8List`.
- We made everything type-safe (no more dynamic).
- Encoding types have been moved to the Body of a Request/Response to simplify the logic when syncing up the headers and to have a single source of truth.
- We've added parsers and validation for all commonly used HTTP headers. E.g., times are represented by DateTime, cookies have their own class with validation of formatting, etc.
- Encoding types have been moved to the `Body` of a `Request`/`Response` to simplify the logic when syncing up the headers and to have a single source of truth.
- We've added parsers and validation for all commonly used HTTP headers. E.g., times are represented by `DateTime`, cookies have their own class with validation of formatting, etc.
- Extended test coverage.
- There are lots of smaller fixes here and there.

Expand Down
Binary file added misc/images/github-banner.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0aaf3d4

Please sign in to comment.