Skip to content

Commit 51eba2c

Browse files
committed
Added documentation
1 parent 15b55f9 commit 51eba2c

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
11
# Valentin
22

33
A collection of utilities to share across projects.
4+
5+
## Utilities
6+
7+
### `valentin/form`
8+
9+
This utility exposes a hook generator. The hook can be used to validate forms.
10+
It makes sure the data is valid, and returns properly typed values.
11+
12+
### `valentin/jwt`
13+
14+
This utility exposes functions to create and read a simple JWT. It relies on an
15+
environment var called `JWT_SECRET`.
16+
17+
### `valentin/Result`
18+
19+
This utility exposes a simple Result object, to handle errors in a more
20+
functional (and typed) manner.
21+
22+
### `valentin/next/api`
23+
24+
This utility exposes helpers to call the API from the client side. You can use
25+
`useQuery` to make `GET` calls, and `useMutation` to make `POST`, `PUT` or
26+
`DELETE` calls. It will automatically forward the current user JWT.
27+
28+
### `valentin/next/endpoint`
29+
30+
This utility exposes helpers to create API endpoints on the server side. More
31+
information on how to setup an API endpoint can be found in
32+
[the API section of this documentation](#api).

0 commit comments

Comments
 (0)