Add deprecation/archival notices

contomap · Dec 30, 2023 · 1a22828 · 1a22828
1 parent 7c14c8d
commit 1a22828
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,11 @@
 [![GoReportCard](https://goreportcard.com/badge/github.com/contomap/iri)](https://goreportcard.com/report/github.com/contomap/iri)
 [![License](https://img.shields.io/github/license/contomap/iri.svg)](https://github.com/contomap/iri/blob/main/LICENSE)
 
+**This repository is archived. Ultimately, there was no need for this library.
+Furthermore, the realization is also that "Resource Identifier" could be an "unlimited"
+data structure, and separate serialization rules then govern whether it becomes an IRI, URI, URL, or whatever flavor (RFC) wanted.
+This would be a further (incompatible) rework of the API.**
+
 This library provides facilities for working with Internationalized Resource
 Identifiers (IRI) as specified in RFC 3987.
 

diff --git a/go.mod b/go.mod
@@ -1,3 +1,4 @@
+// Deprecated: This project is archived. See readme for details.
 module github.com/contomap/iri
 
 go 1.19