Add documentation (#5)

Author: zefir-git

.github/workflows/ci.yml

@@ -45,7 +45,14 @@ jobs:
     needs: build
     if: github.event_name == 'release'
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+      pages: write
     steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
@@ -68,3 +75,18 @@ jobs:
         run: npm publish --provenance --access public
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+
+      - name: Generate docs
+        run: npm run docs
+
+      - name: Set up GitHub pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload docs artifact to pages
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -1,2 +1,3 @@
 node_modules/
 dist/
+docs/

README.md

@@ -1,2 +1,49 @@
-# components
-Base classes for web components
+# @cldn/components
+
+Base classes for creating web components.
+
+This library is intended for use in a web browser environment. A bundler, such as [Webpack](https://webpack.js.org/)
+or [Vite](https://vitejs.dev/) is recommended.
+
+[**Documentation**](https://components.cldn.pro)
+
+## Installation
+
+```shell
+npm i @cldn/components
+```
+
+## Usage
+
+To create your own components, it's recommended to extend one of the classes provided in this library.
+
+For example:
+
+```ts
+import {Component} from "@cldn/components";
+
+class ButtonComponent extends Component<HTMLButtonElement> {
+    public constructor(text: string) {
+        super("button");
+        this.text(text)
+            .class("bg-blue-500", "px-4", "…");
+    }
+}
+```
+
+## Licence
+
+Copyright © 2024 Cloudnode OÜ
+
+This file is part of @cldn/components.
+
+@cldn/components is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General
+Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
+later version.
+
+@cldn/components is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
+warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+details.
+
+You should have received a copy of the GNU Lesser General Public License along with @cldn/components. If not,
+see https://www.gnu.org/licenses/.