docs: recommend upgrading to node 18

blacha · Aug 23, 2023 · 1998daa · 1998daa
1 parent af870fa
commit 1998daa
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ if (img.isTiled()) throw new Error('Tiff is not tiled');
 const tile = await img.getTile(2, 2); // Fetch a tile from a tiff x:2, y:2
 ```
 
-## Scripts
+## Command Line Interface
 
 ```bash
 npm i -g @cogeotiff/cli
@@ -36,7 +36,7 @@ npm i -g @cogeotiff/cli
 Display basic information about COG
 
 ```shell
-cogeotiff info  webp.cog.tif
+cogeotiff info webp.cog.tif
 ```
 
 Output:
@@ -82,7 +82,7 @@ cogeotiff dump --image 2 --output output
 
 # Building
 
-This requires [NodeJs](https://nodejs.org/en/) > 12 & [Yarn](https://yarnpkg.com/en/)
+This requires [NodeJs](https://nodejs.org/en/) >= 18 & [Yarn](https://yarnpkg.com/en/)
 
 Use [n](https://github.com/tj/n) to manage nodeJs versions
 

diff --git a/packages/core/src/source.ts b/packages/core/src/source.ts
@@ -1,3 +1,7 @@
+/**
+ * This is a partial re-implementation of @chunkd/source
+ * this is defined here so that @cogeotiff/core does not have any external dependencies
+ */
 export interface Source {
   /** Where the source is located */
   url: URL;