docs: update readme

multiformats · Feb 5, 2024 · 3f42a05 · 3f42a05
1 parent 81d94e5
commit 3f42a05
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -8,9 +8,9 @@
 
 # About
 
-This module allows easy conversion of Multiaddrs to URLs.
+This module allows easy conversion of Multiaddrs to string URIs.
 
-## Example - Converting multiaddrs to URLs
+## Example - Converting multiaddrs to string URIs
 
 ```js
 import { multiaddrToUri } from '@multiformats/multiaddr-to-uri'

diff --git a/src/index.ts b/src/index.ts
@@ -1,9 +1,9 @@
 /**
  * @packageDocumentation
  *
- * This module allows easy conversion of Multiaddrs to URLs.
+ * This module allows easy conversion of Multiaddrs to string URIs.
  *
- * @example Converting multiaddrs to URLs
+ * @example Converting multiaddrs to string URIs
  *
  * ```js
  * import { multiaddrToUri } from '@multiformats/multiaddr-to-uri'