basic impl

Author: pelikhan

.github/workflows/build.yml

@@ -0,0 +1,18 @@
+name: Build
+
+on:
+    push:
+        branches: [main]
+    pull_request:
+        branches: [main]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-node@v3
+              with:
+                  node-version: 18
+            - run: npm ci
+            - run: npm test    

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+Contributions are welcome.
+
+## Project structures
+
+```
+.devicescript      reserved folder for devicescript generated files
+src/main.ts        default DeviceScript entry point
+...
+```
+
+## Local/container development
+
+-   install [Node.js LTS 18+](https://nodejs.org/en/download)
+
+```bash
+nvm install 18
+nvm use 18
+```
+
+-   install DeviceScript compiler and tools
+
+```bash
+npm install
+```
+
+### Using Visual Studio Code
+
+-   open the project folder in code
+
+```bash
+code .
+```
+
+-   install the [DeviceScript extension](https://microsoft.github.io/devicescript/getting-started/vscode)
+
+-   start debugging!
+
+### Using the command line
+
+-   start the watch build and developer tools server
+
+```bash
+npm run watch
+```
+
+-   navigate to devtools page (see terminal output)
+    to use the simulators or deploy to hardware.
+
+-   open `src/main.ts` in your favorite TypeScript IDE and start editing.

README.md

@@ -1,53 +1,18 @@
-# - project name -
+# Note client for DeviceScript
 
-This project uses [DeviceScript](https://microsoft.github.io/devicescript/).
+This project uses [DeviceScript](https://microsoft.github.io/devicescript/)
+to interact with a [blues.io Notecard](https://blues.io/products/notecard/).
 
-## Project structures
-
-```
-.devicescript      reserved folder for devicescript generated files
-src/main.ts        default DeviceScript entry point
-...
-```
+This library uses the [serial-to-i2c bridge](// https://dev.blues.io/guides-and-tutorials/notecard-guides/serial-over-i2c-protocol/).
 
+** This library has a minimal surface and most messages have not been mapped to types. See [Notecard API](https://dev.blues.io/api-reference/notecard-api/introduction/) for a full list. **
 
-## Local/container development
+## Usage
 
--  install [Node.js LTS 18+](https://nodejs.org/en/download)
+Add the library to your project:
 
 ```bash
-nvm install 18
-nvm use 18
+npm install --save pelikhan/devicescript-note
 ```
 
--  install DeviceScript compiler and tools
-
-```bash
-npm install
-```
-
-### Using Visual Studio Code
-
-- open the project folder in code
-
-```bash
-code .
-```
-
-- install the [DeviceScript extension](https://microsoft.github.io/devicescript/getting-started/vscode)
-
-- start debugging!
-
-### Using the command line
-
-- start the watch build and developer tools server
-
-```bash
-npm run watch
-```
-
--  navigate to devtools page (see terminal output) 
-to use the simulators or deploy to hardware.
-
--  open `src/main.ts` in your favorite TypeScript IDE and start editing.
-
+## [Contributing](./CONTRIBUTING.md)

package.json

@@ -1,6 +1,6 @@
 {
+    "name": "devicescript-note",
     "version": "0.0.0",
-    "private": "Please use 'yarn devs add npm' to make this a publishable package",
     "dependencies": {},
     "devDependencies": {
         "@devicescript/cli": "latest"
@@ -15,5 +15,22 @@
         "test:devicescript": "devicescript run src/main.ts --test --test-self-exit",
         "test": "npm run test:devicescript",
         "start": "npm run watch"
+    },
+    "main": "./src/index.ts",
+    "license": "MIT",
+    "devicescript": {
+        "library": true
+    },
+    "files": [
+        "src/*.ts",
+        "devsconfig.json"
+    ],
+    "keywords": [
+        "devicescript"
+    ],
+    "author": "pelikhan <jhalleux@microsoft.com>",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/pelikhan/devicescript-note.git"
     }
 }