diff --git a/README.md b/README.md index 89896ff..1fe4b41 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,30 @@ > https://href.plus * If you find a release that has a link which just shows the domain and not a proper name, please post it in [#5](https://github.com/Bauke/href-plus/issues/5). Thank you! + +## Building + +*Requires a recent version of [Node](https://nodejs.org) and [pnpm](https://pnpm.io).* In the command-line: + +```sh +# Clone the repository. +git clone https://github.com/Bauke/href-plus.git + +# Move into it. +cd href-plus + +# Install the dependencies. +pnpm install + +# Start a local development server. +pnpm start -- --open + +# Build for production. +pnpm vite build --emptyOutDir +``` + +## License + +This project is licensed under the [GPL-3.0-or-later](LICENSE) license. + +Icons in [`source/assets/icons`](source/assets/icons) belong to their respective owners.