diff --git a/README.md b/README.md index beb03fe..3af0bae 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ -# WTK +# The Web Tool Kit -The Web Tool Kit. \ No newline at end of file +The Web Tool Kit provides the components to build the GUIs of web applications. + +## How to use it in your projects + +WTK comes a [SJW](https://git.marvid.fr/Tissevert/SJW) package. + +### With [`guix`](https://guix.gnu.org/) + +The easiest way to use WTK in your web projects is to simply [package them with +`guix`](https://git.marvid.fr/Tissevert/SJW#how-not-to-install). + +### Otherwise + +You can follow [these +instructions](https://git.marvid.fr/Tissevert/SJW#when-guix-is-not-an-option) +to use it without `guix`.