docs: update readme

achingbrain · achingbrain · commit 3f42a05e56fa · 2024-02-05T18:03:53.000+01:00
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'

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`	`1`	`/**`
`2`	`2`	`* @packageDocumentation`
`3`	`3`	`*`
`4`		`- * This module allows easy conversion of Multiaddrs to URLs.`
	`4`	`+ * This module allows easy conversion of Multiaddrs to string URIs.`
`5`	`5`	`*`
`6`		`- * @example Converting multiaddrs to URLs`
	`6`	`+ * @example Converting multiaddrs to string URIs`
`7`	`7`	`*`
`8`	`8`	* ```js
`9`	`9`	`* import { multiaddrToUri } from '@multiformats/multiaddr-to-uri'`