Skip to content

Commit

Permalink
docs: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Julien-R44 committed Apr 29, 2024
1 parent 620c96e commit e709ed9
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Tuyau

> [!WARNING]
> Tuyau is still in early development. I will NOT follow semver until the first 1.0.0. Use at your own risk.
> Tuyau is still in early development. I will **NOT follow semver until 1.0.0**. Use at your own risk.
Set of tools to create typesafe APIs using AdonisJS. The monorepo includes the following packages:

Expand All @@ -15,6 +15,7 @@ The main goal of this project is to provide some utilities to have better typesa

- **Done (Experimental)** : Provide an RPC-like client that is fully e2e typesafe ( like tRPC, Elysia Eden, Hono etc. )
- **In Progress** : Provide a [Ziggy](https://github.com/tighten/ziggy)-like helper to generate and use routes in the frontend.
- **Not started** : Provide some Inertia helpers to have better typesafety when using Inertia in your AdonisJS project. Things like typesafe `<Link />` and `useForm`.
- **Not started** : Provide a specific Controller class that will allow to have better typesafety when creating your endpoints.
- **Not started** : Having an automatic OpenAPI generation + Swagger/Scalar UI viewer based on Tuyau codegen. Still not sure about this one.

Expand Down

0 comments on commit e709ed9

Please sign in to comment.