Prepare package for publication

Author: MunGell

.github/workflows/npm.yml

@@ -0,0 +1,20 @@
+name: Publish to npm
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: |
+          npm install
+          npm run build
+          npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Release Build
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION: ${{ github.ref }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          draft: false
+          prerelease: false

.npmignore

@@ -0,0 +1,4 @@
+.eslintrc
+.gitignore
+tsconfig.json
+index.ts

README.md

@@ -0,0 +1,20 @@
+# Obsidian Plugin API
+
+Standartized way of exposing and using Obsidian Plugin APIs
+
+## Installation
+
+```shell
+npm install --save-dev @vanakat/plugin-api
+```
+
+## Usage
+
+This module exposes 2 functions:
+
+* `registerAPI(name, api, plugin)` - registers plugin API in global variable (`window`)
+* `pluginApi(name)` - returns plugin API based on its name
+
+## License
+
+MIT

package.json

@@ -1,14 +1,15 @@
 {
-  "name": "obsidian-plugin-api",
+  "name": "@vanakat/plugin-api",
   "version": "0.1.0",
   "description": "Obsidian helper for inter-plugin API communication",
-  "main": "index.ts",
+  "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsc"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/MunGell/plugin-api.git"
+    "url": "git+https://github.com/vanakat/plugin-api.git"
   },
   "keywords": [
     "obsidian",
@@ -19,9 +20,9 @@
   "author": "Shmavon Gazanchyan <[email protected]> (https://github.com/MunGell)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/MunGell/plugin-api/issues"
+    "url": "https://github.com/vanakat/plugin-api/issues"
   },
-  "homepage": "https://github.com/MunGell/plugin-api#readme",
+  "homepage": "https://github.com/vanakat/plugin-api#readme",
   "dependencies": {
     "@typescript-eslint/eslint-plugin": "^5.2.0",
     "@typescript-eslint/parser": "^5.2.0",

tsconfig.json

@@ -1,5 +1,6 @@
 {
     "compilerOptions": {
+        "declaration": true,
         "inlineSourceMap": true,
         "inlineSources": true,
         "module": "ESNext",