-
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Improved & styled README.md (#53)
* docs: Improved & styled README.md * fix(docs): Fixed README to respect prettier * fix(docs): README reformatted to lint rules
- Loading branch information
Showing
1 changed file
with
76 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,77 @@ | ||
# End-to-end typesafe APIs builder, Developer-first simplicity | ||
<div align="center"> | ||
<image align="center" src="https://i.ibb.co/rZw671M/New-Project-2.png" width=400 /> | ||
</div> | ||
|
||
This project is still in heavy development, you can read the docs [here](https://orpc.unnoq.com). | ||
<h1></h1> | ||
|
||
<div align="center"> | ||
|
||
 | ||
 | ||
 | ||
 | ||
|
||
</div> | ||
|
||
<p align="center">End-to-end typesafe APIs built quicker & easier</p> | ||
|
||
> [!NOTE] | ||
> This project is still in heavy development, please be mindful of breaking changes. | ||
**oRPC is a powerful combination of RPC and OpenAPI, offering an exceptional developer experience powered by TypeScript. It's designed to be simple and straightforward to use.** | ||
|
||
--- | ||
|
||
## Features | ||
|
||
- **Type-safe π**: oRPC is built on top of TypeScript, which means you get full type safety out of the box. | ||
- **Easy to use βοΈ**: oRPC is designed to be simple and straightforward to use. | ||
- **Contract first π**: Take advantage of a "contract first" approach to developing your API. | ||
- **Built-in plugins π**: Easily implement into your favourite frameworks. | ||
|
||
--- | ||
|
||
## Documentation & Examples | ||
|
||
You can find the full documentation & examples [here](https://orpc.unnoq.com). | ||
|
||
--- | ||
|
||
## Packages | ||
|
||
- `@orpc/contract`: Build your API contract. | ||
- `@orpc/server`: Handle your contract on the server. | ||
- `@orpc/client`: Consume your contract on the client. | ||
- `@orpc/react`: React hooks for your client. | ||
- `@orpc/react-query`: React Query wrapper for your client. | ||
- `@orpc/vue-query`: Vue Query wrapper for your client. | ||
- `@orpc/openapi`: Generate an OpenAPI spec from your contract. | ||
- `@orpc/next`: Next.js API server handler. | ||
- `@orpc/zod`: Specialised Zod schema types for your contract. | ||
|
||
--- | ||
|
||
## Comparison | ||
|
||
This comparison table helps you understand how oRPC differs from other popular TypeScript RPC and REST solutions. | ||
|
||
- β First-class, built-in support. | ||
- π‘ Lacks features, or requires third-party integrations. | ||
- π Not supported or not documented. | ||
|
||
| Feature | oRPC | tRPC | ts-rest | Description | | ||
| -------------------------- | ---- | ---- | ------- | -------------------------------------------------------- | | ||
| End-to-end Type Safety | β | β | β | Full TypeScript type inference from backend to frontend. | | ||
| SSR Support | β | β | β | Server-side rendering compatibility. | | ||
| React Query Integration | β | β | π‘ | Native support for React Query/TanStack Query. | | ||
| Vue Query Integration | β | π | π‘ | Native support for Vue Query/TanStack Query. | | ||
| Contract-First Development | β | π | β | API definitions before implementation. | | ||
| File Operations | β | π‘ | π‘ | Built-in support for file uploads/downloads. | | ||
| OpenAPI Support | β | π‘ | π‘ | Generation and consumption of OpenAPI specs. | | ||
| Server Actions Support | β | β | π | React/Next.js Actions compatibility. | | ||
|
||
--- | ||
|
||
## License | ||
|
||
Distributed under the MIT License. See [LICENSE](LICENSE) for more information. |