From 8e6b688b323013db164e79e60322a5ff29a6310d Mon Sep 17 00:00:00 2001 From: Ivan Jobs Date: Wed, 22 Apr 2020 10:48:49 +0800 Subject: [PATCH] suggestions for readme.md and package.json --- README.md | 30 +++++++++++++++++++++++++++++- package.json | 8 ++++---- 2 files changed, 33 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e62decd..ca15c6c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,32 @@ -# IoT Plug and Play for Visual Studio Code +# Azure IoT PnP Authoring for Visual Studio Code + +## Overview +The Azure IoT PnP Authoring is a Visual Studio Code extension that supports working with [IoT Plug and Play](https://docs.microsoft.com/azure/iot-pnp/overview-iot-plug-and-play) by authoring *device capability interfaces. + +## Get Started + +### Develop device using IoT Plug and Play + +[IoT Plug and Play public preview](https://docs.microsoft.com/azure/iot-pnp/) is a *device capability model schema* that describes device capabilities. The Azure IoT PnP Authoring extension provides an integrated environment to author IoT Plug and Play *device capability *interfaces. + +Learn how to get started with IoT Plug and Play and use the PnP Authoring extension to build an IoT Plug and Play device: + +- [What is IoT Plug and Play](https://docs.microsoft.com/azure/iot-pnp/overview-iot-plug-and-play) and the [Digital Twin Definition Language (DTDL)](https://aka.ms/DTDL) that enables it. +- [Quickstart: Use a device capability model to create an IoT Plug and Play device](https://docs.microsoft.com/azure/iot-pnp/quickstart-create-pnp-device) +- [Build an IoT Plug and Play Preview device that's ready for certification](https://docs.microsoft.com/azure/iot-pnp/tutorial-build-device-certification) + +## Commands + +### IoT Plug and Play + +| Command | Description | +| --- | --- | +| `IoT Plug and Play: Create Interface...` | Create new IoT Plug and Play interface file. | + +## Privacy Statement + +The [Microsft Enterprise and Developer Privacy Statement](https://www.microsoft.com/privacystatement/EnterpriseDev/default.aspx) describes the privacy statement of this software. + ## Contributing diff --git a/package.json b/package.json index 9582a06..8a5e95f 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,11 @@ { - "name": "azure-digital-twins", - "displayName": "IoT Plug and Play", - "description": "Author IoT Plug and Play models, publish and manage with Model Repository", + "name": "vscode-iot-pnp-authoring", + "displayName": "Azure IoT PnP Authoring", + "description": "This extension is now a part of Azure IoT Tools extension pack. We highly recommend installing Azure IoT Tools to get full capabilities for Azure IoT development.", "version": "0.0.1", "publisher": "vsciot-vscode", "preview": true, - "aiKey": "25cf12e8-2dc7-4556-b54e-40fb9d1dfba1", + "aiKey": "[AIKEY PLACEHOLDER]", "icon": "logo.png", "license": "SEE LICENSE IN LICENSE.txt", "engines": {