1
Fork 0

Rewrite readme.

This commit is contained in:
Bauke 2022-09-29 16:27:47 +02:00
parent 37dfcfc1f0
commit 4bddf6c9f7
Signed by: Bauke
GPG Key ID: C1C0F29952BCF558
1 changed files with 2 additions and 25 deletions

View File

@ -1,32 +1,9 @@
# href+
> 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
```
> **Song-linking website using MusicBrainz data.**
## License
This project is licensed under the [GPL-3.0-or-later](LICENSE) license.
Distributed under the [GPL-3.0-or-later](https://spdx.org/licenses/GPL-3.0-or-later.html) license, see [LICENSE](https://git.bauke.xyz/Bauke/href-plus/src/branch/main/LICENSE) for more information.
Icons in [`source/assets/icons`](source/assets/icons) belong to their respective owners.