From 709c799de5350bef5e1a1e8dd0a0e47f0a265f03 Mon Sep 17 00:00:00 2001 From: Kilian Finger Date: Wed, 8 Feb 2023 19:25:03 +0100 Subject: [PATCH] Improve node docs with available platforms (#786) --- platform/node/README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/platform/node/README.md b/platform/node/README.md index 7754ce201..a9c73c704 100644 --- a/platform/node/README.md +++ b/platform/node/README.md @@ -1,18 +1,16 @@ # @maplibre/maplibre-gl-native -[![NPM](https://nodei.co/npm/@maplibre/maplibre-gl-native.png)](https://npmjs.org/package/@maplibre/maplibre-gl-native) +[![Version](https://img.shields.io/npm/v/@maplibre/maplibre-gl-native?style=flat)](https://www.npmjs.com/package/@maplibre/maplibre-gl-native) [![node-ci](https://github.com/maplibre/maplibre-gl-native/actions/workflows/node-ci.yml/badge.svg)](https://github.com/maplibre/maplibre-gl-native/actions/workflows/node-ci.yml) ## Installing -#### :warn: This package isn't live yet. +Binaries are available and downloaded during install for the following platforms: -Requires a modern C++ runtime that supports C++14. - -By default, installs binaries. On these platforms no additional dependencies are needed. - -- 64 bit macOS or 64 bit Linux -- Node.js v10.x +- Operating systems: + - Ubuntu 20.04 (amd64/arm64) + - macOS 12 (amd64/arm64) +- Node.js 14, 16, 18 Run: @@ -20,8 +18,7 @@ Run: npm install @maplibre/maplibre-gl-native ``` -Other platforms will fall back to a source compile with `make node`; see [DEVELOPING.md](DEVELOPING.md) for details on -building from source. +Further platforms might work [with additional libraries installed](https://github.com/maplibre/maplibre-gl-native/tree/main/platform/linux#prerequisites). ## Testing