From 3ae3960d793f136bbc54e8534fc344ab55e19db1 Mon Sep 17 00:00:00 2001 From: Bauke Date: Wed, 16 Mar 2022 01:09:24 +0100 Subject: [PATCH] Create the readme. --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..636cccf --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Gram + +> Opinionated component library using [HTM] & [Preact]. + +[HTM]: https://github.com/developit/htm +[Preact]: https://preactjs.com/ + +## Installation + +Add `@holllo/gram`, `htm` and `preact` with your Node package manager of choice ([pnpm] in our case). + +[pnpm]: https://pnpm.io + +```sh +pnpm add @holllo/gram htm preact +``` + +## Components + +* [PrivacyLink](source/links/privacy-link.ts) + +## License + +Gram is open-sourced with the [GPL-3.0-or-later] license. + +[GPL-3.0-or-later]: https://github.com/Holllo/gram/blob/main/LICENSE