Merge pull request #23 from Yuripetusko/master

Switch to npmjs registry instead of github registry, as github packages are more suited towards private repos

Author: Yuripetusko

.github/workflows/cd.yml

@@ -23,8 +23,7 @@ jobs:
         with:
           node-version: 14
           # Specifies the registry, this field is required!
-          registry-url: https://npm.pkg.github.com/
-          scope: "@Swader"
+          registry-url: 'https://registry.npmjs.org'
       # clean install of your projects' deps. We use "npm ci" to avoid package lock changes
       - run: yarn install
       # set up git since we will later push to the repo
@@ -34,9 +33,9 @@ jobs:
       # run tests just in case
       - run: yarn test
       # publish to NPM -> there is one caveat, continue reading for the fix
-      - run: yarn publish
+      - run: npm publish
         env:
-          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
       # push the version changes to GitHub
       - run: git push
         env:

README.md

@@ -8,7 +8,7 @@ Typescript implementation of the [RMRK spec](https://github.com/Swader/rmrk-spec
 
 > Note: NodeJS 14+ is required. Please install with [NVM](https://nvm.sh).
 
-`yarn install @Swader/rmrk-tools`
+`yarn install rmrk-tools`
 
 ## Usage
 
@@ -50,7 +50,33 @@ const fetchAndConsolidate = async () => {
 </script>
 ```
 
-TBD
+### CLI
+
+You can use this package as a CLI tool
+`npm install --save-dev rmrk-tools@latest`
+
+Now you can use rmrk-tools coomands in your bash or npm scripts:
+You can use any of the available [Helper Tools](#helper-tools) by prepending `rmrk-tools-`
+
+```
+"scripts": {
+  "fetch": "rmrk-tools-fetch",
+  "consolidate": "rmrk-tools-consolidate",
+  "seed": "rmrk-tools-seed",
+  "getevents": "rmrk-tools-getevents",
+  "validate": "rmrk-tools-validate",
+  "run-listener": "rmrk-tools-run-listener"
+},
+```
+
+Or in bash scripts
+
+```
+#! /usr/bin/env node
+var shell = require("shelljs");
+
+shell.exec("rmrk-tools-fetch");
+```
 
 ## API
 

package.json

@@ -1,14 +1,11 @@
 {
-  "name": "@Swader/rmrk-tools",
-  "version": "0.0.1",
+  "name": "rmrk-tools",
+  "version": "0.0.6",
   "description": "Suite of libraries implementing RMRK.app specs",
   "repository": {
     "type": "git",
     "url": "https://github.com/Swader/rmrk-tools"
   },
-  "publishConfig": {
-    "registry": "https://npm.pkg.github.com/"
-  },
   "main": "dist/index.cjs",
   "module": "./dist/index.es.js",
   "types": "./dist/index.d.ts",
@@ -45,12 +42,12 @@
     "prepublishOnly": "yarn build"
   },
   "bin": {
-    "rmrk-tools:fetch": "dist-cli/cli/fetch.js",
-    "rmrk-tools:consolidate": "dist-cli/cli/consolidate.js",
-    "rmrk-tools:seed": "dist-cli/cli/seed.js",
-    "rmrk-tools:getevents": "dist-cli/cli/getevents.js",
-    "rmrk-tools:validate": "dist-cli/cli/validate.js",
-    "rmrk-tools:run-listener": "dist-cli/cli/run-listener.js"
+    "rmrk-tools-fetch": "dist-cli/cli/fetch.js",
+    "rmrk-tools-consolidate": "dist-cli/cli/consolidate.js",
+    "rmrk-tools-seed": "dist-cli/cli/seed.js",
+    "rmrk-tools-getevents": "dist-cli/cli/getevents.js",
+    "rmrk-tools-validate": "dist-cli/cli/validate.js",
+    "rmrk-tools-run-listener": "dist-cli/cli/run-listener.js"
   },
   "author": "Bruno Skvorc <[email protected]>",
   "license": "GPL-3.0",

tsconfig.cli.json

@@ -3,6 +3,6 @@
   "compilerOptions": {
     "module":"commonjs",
   },
-  "include": ["cli/*.ts"],
+  "include": ["cli/*.ts", "src/*.ts", "src/**/*.ts"],
   "files": ["cli/index.ts"]
 }