about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
authorMarkus Wüstenberg2024-10-03 11:26:44 +0200
committerGitHub2024-10-03 11:26:44 +0200
commitfe24f0575214093cc72201ecc1cc463865dcb1e2 (patch)
tree0a96f8c9162c05f93a5506ec1cf85aef48bb8106 /README.md
parenta58043d58789f95046a567d2ad1bde55e352d5f0 (diff)
downloadgomponents-fe24f0575214093cc72201ecc1cc463865dcb1e2.tar.lz
gomponents-fe24f0575214093cc72201ecc1cc463865dcb1e2.tar.zst
gomponents-fe24f0575214093cc72201ecc1cc463865dcb1e2.zip
Move module to maragu.dev/gomponents namespace (#215)
This is a breaking change to move gomponents to my own import namespace.

I will obviously be careful with this, test it out in all kinds of
scenarios, release betas, etc. But otherwise, because the `Node`
interface is so simple and has basically never changed, I don't think
this will break much. 🤞

Fixes #200
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/README.md b/README.md
index 6e1b6ca..6ae12c9 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,10 @@
 
 <img src="logo.png" alt="Logo" width="300" align="right"/>
 
-[![GoDoc](https://pkg.go.dev/badge/github.com/maragudk/gomponents)](https://pkg.go.dev/github.com/maragudk/gomponents)
+[![GoDoc](https://pkg.go.dev/badge/maragu.dev/gomponents)](https://pkg.go.dev/maragu.dev/gomponents)
 [![Go](https://github.com/maragudk/gomponents/actions/workflows/ci.yml/badge.svg)](https://github.com/maragudk/gomponents/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/maragudk/gomponents/branch/main/graph/badge.svg)](https://codecov.io/gh/maragudk/gomponents)
-[![Go Report Card](https://goreportcard.com/badge/github.com/maragudk/gomponents)](https://goreportcard.com/report/github.com/maragudk/gomponents)
+[![Go Report Card](https://goreportcard.com/badge/maragu.dev/gomponents)](https://goreportcard.com/report/maragu.dev/gomponents)
 
 Try HTML components in pure Go.
 
@@ -13,7 +13,9 @@ _gomponents_ are HTML components written in pure Go.
 They render to HTML 5, and make it easy for you to build reusable components.
 So you can focus on building your app instead of learning yet another templating language.
 
-The API may change until version 1 is reached.
+```shell
+go get maragu.dev/gomponents
+```
 
 Made with ✨sparkles✨ by [maragu](https://www.maragu.dev/).
 
@@ -40,7 +42,7 @@ Check out [www.gomponents.com](https://www.gomponents.com) for an introduction.
 ## Usage
 
 ```shell
-go get github.com/maragudk/gomponents
+go get maragu.dev/gomponents
 ```
 
 The preferred way to use gomponents is with so-called dot-imports (note the dot before the imports),
@@ -50,9 +52,9 @@ to give you that smooth, native HTML feel:
 package main
 
 import (
-	. "github.com/maragudk/gomponents"
-	. "github.com/maragudk/gomponents/components"
-	. "github.com/maragudk/gomponents/html"
+	. "maragu.dev/gomponents"
+	. "maragu.dev/gomponents/components"
+	. "maragu.dev/gomponents/html"
 )
 
 func Navbar(authenticated bool, currentPath string) Node {